Documentation Menu

Self-Hosted Deployment

Deploy BugSpotter on your own infrastructure with Docker Compose. Full feature parity with SaaS — including AI intelligence on self-hosted Ollama.

Prerequisites

  • Docker 20.10+ with Docker Compose v2
  • Linux server (Ubuntu 22.04+ recommended)
  • Hardware: 2 CPU / 4 GB RAM minimum (without AI), 4 CPU / 16 GB RAM (with AI/Ollama)
  • Disk: 20 GB free space

Quick Start

git clone https://github.com/apex-bridge/bugspotter-deploy
cd bugspotter-deploy
bash install.sh

The install script will:

  1. Check prerequisites (Docker, Compose, openssl)
  2. Generate secure secrets (JWT, encryption keys, passwords)
  3. Pull Docker images from GitHub Container Registry
  4. Start all services
  5. Print access URLs when ready

Services

ServiceDescriptionPort
Admin PanelWeb UI80
APIBackend REST API3000
WorkerBackground job processor(internal)
PostgreSQLDatabase(internal)
RedisJob queues & cache(internal)
MinIOS3-compatible storage(internal)

Enable AI Features

# Start with AI services (Ollama + pgvector)
docker compose --profile intelligence up -d

# First start downloads the LLM model (~4.7 GB)
# Then enable in .env:
#   INTELLIGENCE_ENABLED=true
docker compose up -d

AI features require 4 CPU / 16 GB RAM minimum.

Configuration

Edit .env to customize your deployment. Key settings:

VariableDescriptionDefault
ADMIN_PORTAdmin panel port80
API_PORTAPI port3000
CORS_ORIGINSAllowed originshttp://localhost
FRONTEND_URLAdmin panel URLhttp://localhost
SMTP_HOSTEmail server(disabled)

Upgrading

docker compose pull
docker compose up -d

Backup

# Database
docker compose exec postgres pg_dump -U bugspotter bugspotter > backup.sql

Security

  • Only API and Admin ports are exposed. Database, Redis, and MinIO communicate on the internal Docker network.
  • Place a reverse proxy (nginx, Caddy, Traefik) in front for TLS termination.
  • Software is free under FSL-1.1 license. Becomes Apache 2.0 after 2 years.

Next: API Reference →