Skip to content

Installation

BugFuse ships with a Docker Compose setup that brings up Postgres, runs database migrations, and starts the backend and frontend.

  • Docker with the Compose plugin
  • That’s it. Postgres runs inside the Compose stack, and Redis, SMTP, and S3 are optional.
Terminal window
git clone https://github.com/hemantapkh/Bugfuse
cd Bugfuse
docker compose up -d

Open http://localhost:3000 and register your first account.

The stack works with zero configuration for a local try-out. For a real deployment, create a .env file next to compose.yml:

Terminal window
# Port the app is exposed on (default: 3000)
BUGFUSE_PORT=3000
# Public URL of your instance (used in emails and links)
APP_URL=https://bugfuse.example.com
# Pin the JWT secret so sessions survive restarts
JWT_SECRET_KEY=<generate with: openssl rand -base64 32>

By default the bundled Postgres uses the bugfuse/bugfuse credentials and stores data in a named Docker volume (bugfuse_postgres_data). To use an external Postgres instead, set BUGFUSE_DATABASE_URL and remove the db service.

See the configuration reference for every setting, including SMTP (needed for email verification, password resets, and invites), Redis caching, and S3 artifact storage.

Run BugFuse behind your reverse proxy (Caddy, nginx, Traefik) with TLS and point APP_URL at the public URL. If your proxy sets X-Forwarded-For, enable SENTRY_TRUST_PROXY_HEADERS=true so client IPs are recorded correctly.

Terminal window
git pull
docker compose up -d --build

Migrations run automatically via the migrate service before the backend starts.