Skip to content

Install and distribution access

This guide covers the BugFence application, not the static documentation site hosted on Cloudflare Pages. Hosting the docs does not install the application.

  • Obtain the production Compose file, its deploy directory, and a release tag through your distribution channel. Confirm that the release and its deployment scripts are compatible with your installation.
  • Install Docker Engine and Docker Compose on a host with persistent storage, outbound registry access, and an ingress configuration appropriate for your network.
  • The Compose file pulls application images from GitHub Container Registry (GHCR). Do not assume anonymous access: confirm that your account is authorized for each image and tag. Private images require a prior docker login ghcr.io with a credential authorized to read the packages. Keep that credential out of the Compose file, shell history, and logs.
  • If you install an SDK package separately, check its registry and authentication requirements; access to application images does not imply access to SDK packages.
  • Choose an application hostname, arrange DNS and TLS, and decide whether to use the file store or PostgreSQL. Create a protected .env file alongside the Compose file; see configuration and networking.

The supplied deploy/deploy.sh expects .env, a lowercase GHCR_OWNER, and optionally GHCR_REPO. It defaults to the caddy profile when no profile is configured. Use an available immutable release tag rather than relying on latest:

Terminal window
deploy/deploy.sh release RELEASE_TAG
deploy/deploy.sh status

Replace RELEASE_TAG with your authorized image tag. The script pulls the images, starts the configured services and checks health. A first installation has no previous release to restore automatically. See upgrades and recovery before changing a running installation.

The production Compose file runs server, dashboard and demo services. Caddy or Cloudflare Tunnel can provide application ingress; the optional postgres profile adds a local PostgreSQL service. The server and dashboard ports are internal to the Compose network.