OpenFlare/docs/en/deployment/index.md

Deployment & Upgrade

This section provides detailed deployment guides, configuration instructions, and upgrade maintenance procedures for the OpenFlare Server, Agent, Relay, and the OpenFlared client.

Content Navigation

Quick Start

• Quick Start: Start the Server and your first Agent in under 5 minutes using Docker Compose (recommended for new users).

Server Deployment

• Launch Server: Learn how to build the frontend from source, start the Server, and choose between SQLite or PostgreSQL.

Agent Deployment

• Deploy Agent: Explore Agent connection methods, Docker deployment, host script installation, config files, and troubleshooting.

Tunnel Intranet Penetration Deployment

• Deploy Relay: View config descriptions, Docker deployment, and host runtime guides for TunnelRelay nodes.
• Deploy OpenFlared: Access config descriptions, Docker runtime, and auto-sync mechanisms for the intranet client.

Upgrade & Maintenance

• Upgrade & Maintenance: Discover upgrading procedures for Server/Agent, data retention rules, and validation commands.

Reference Manuals

• Deployment Guide: Browse deployment topologies, prerequisites, Docker Compose samples, and multiple deployment strategies.