ryan
2.3 KiB
Guide
You will learn how the OpenFlare documentation is organized, which pages to read for a first run, and where to find deployment, usage, troubleshooting, and development information.
OpenFlare is a self-hosted OpenResty control plane. It brings reverse proxy site configuration, immutable releases, Agent-based node sync, TLS certificates, and basic observability into one management UI for a single team or organization.
Recommended Path
If you are new to OpenFlare, read these pages in order:
- Quick Start: start the Server with Docker Compose, sign in, and connect the first Agent.
- Usage: learn common operations for sites, origins, certificates, releases, rollbacks, and observability.
- Deployment: run the Server and Agent in an environment closer to production.
- Configuration: look up Server environment variables, runtime options, and Agent configuration fields.
- Troubleshooting: debug login, database, node sync, OpenResty apply, and frontend build issues.
Find by Role
| Goal | Start Here |
|---|---|
| Run the management UI in a few minutes | Quick Start |
| Publish the first reverse proxy site | Publish First Site |
| Connect or reinstall a node Agent | Connect Agent |
| Start the Server from source | Run Server |
| Configure GitHub or OIDC login | SSO Login |
| Upgrade the Server or Agent | Upgrade and Maintenance |
| Contribute code or fix issues | Local Development and Development Constraints |
| Understand architecture and releases | Architecture and Release Model |
Documentation Areas
guide/ is for users and operators. It provides executable steps from installation to daily operations.
reference/ collects stable facts, such as configuration fields, commands, API conventions, and repository layout.
design/ is for maintainers and contributors. It describes product boundaries, architecture, release model, and engineering constraints. Update the related design page before implementing changes that alter those boundaries.