Deployment & Upgrades

This section provides detailed deployment guides, configuration notes, and upgrade/maintenance steps for the OpenFlare Server, Agent, Relay, and the OpenFlared intranet penetration client.

Content Navigation

Quick Start

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

Server Deployment

• Start the Server: build the frontend from source, start the Server, choose SQLite or PostgreSQL

Agent Deployment

• Access Agent: Agent connection methods, Docker deployment, script install, config file, and troubleshooting

Tunnel Intranet Penetration Deployment

• Deploy Relay: TunnelRelay node config notes, Docker deployment, and host running guide
• Deploy OpenFlared: intranet penetration client config notes, Docker running, and self-sync mechanism

Upgrades & Maintenance

• Upgrade & Maintenance: Server and Agent upgrade steps, data cleanup policy, verification commands

Reference

• Deployment Guide: deployment topology, prerequisites, Docker Compose config examples, and an overview of multiple deployment approaches