F Forge DocsRepository ↗FeaturesUser manual

Start here

Requirements and supported platforms

Use the operating systems and deployment model the installer and Compose files actually support.

Repository-validated operator guidance View source ↗

#Platform support

PlatformStatusEvidence
Ubuntu 22.04 LTSSupportedListed by scripts/install.sh.
Ubuntu 24.04 LTSSupportedListed by scripts/install.sh.
Debian 12SupportedListed by scripts/install.sh.
macOS 14–15Development onlyRecognized by the installer; do not use as a production Beacon host.
Other LinuxNot testedNo installer claim is made.
WindowsNot supported for host deploymentNo supported installer path is supplied.

#Host prerequisites

  • Docker Engine and the Docker Compose v2 plugin.
  • A non-root operator account able to run Docker commands.
  • A domain and public DNS control for public TLS.
  • Outbound HTTPS access for image pulls, certificate issuance, Git, and optional object storage.
  • A persistent disk for PostgreSQL and Beacon workload files.

#Check Docker before installation

Host verification
docker info
docker compose version
docker compose version --short

#Security boundary

Do not publish internal services

PostgreSQL, Redis, the Beacon API, monitoring dashboards, and Caddy’s admin API are not public panel endpoints. In the production override they bind to loopback; expose only the proxy and deliberately allocated game ports.

Made by Riyaz with love