Documentation

Get bum.pt running in under 5 minutes:

git clone https://github.com/Berg-io/bum.pt.git
cd bum.pt
cp .env.example .env
docker compose up -d

Open https://localhost and log in with the default credentials:

Change the default password immediately after first login.

• Docker and Docker Compose
• 1 CPU core, 512 MB RAM minimum
• Ports 80/443 available (configurable)

bum.pt is distributed as a Docker image. The included docker-compose.yml sets up the app, a Caddy reverse proxy (HTTPS), and a cron scheduler.

# Clone the repository
git clone https://github.com/Berg-io/bum.pt.git
cd bum.pt

# Copy and edit configuration
cp .env.example .env

# Generate secure secrets
# Linux/macOS:
sed -i "s/JWT_SECRET=.*/JWT_SECRET=\"$(openssl rand -hex 32)\"/" .env
sed -i "s/CRON_SECRET=.*/CRON_SECRET=\"$(openssl rand -hex 32)\"/" .env

# Build and start
docker compose up -d

All configuration is done via environment variables in the .env file.

Application

bum.pt runs in Community Edition by default (up to 25 monitored items). To unlock unlimited items, SSO, and API keys, you need a Professional license.

Activating your license

1. Purchase a Professional license at bum.pt
2. Copy the license key from your email or Polar customer portal
3. Add it to your .env:

LICENSE_KEY="BUM_your_license_key_here"

4. Restart your container:

docker compose restart

The license is validated automatically. If the key is valid, Professional features are unlocked immediately.

What happens when the license expires?

The app gracefully degrades to Community Edition. Your data is never lost. Renew your license to restore Professional features.

bum.pt supports 4 database engines:

• SQLite (default) — no extra setup
• PostgreSQL — Docker container included
• MariaDB — Docker container included
• MSSQL — external server (Professional)

Set DB_TYPE and DATABASE_URL in your .env. See the README for full examples.

Caddy is included as a reverse proxy and handles HTTPS automatically. Three TLS modes are available:

• Self-signed (default) — for development and internal networks
• Custom certificates — place your .crt and .key in the certs/ folder
• Let's Encrypt — automatic certificates for public domains

docker compose down
docker compose build --no-cache
docker compose up -d

Database migrations are applied automatically on startup. Your data and settings are preserved.