Configuration Reference

Most BugPin settings are configured through the Admin UI. Environment variables are only needed for advanced server-level configuration.

Default Setup

BugPin works out of the box with sensible defaults:

• Admin account: admin@example.com / changeme123
• Session key: Auto-generated on first run
• Port: 7300
• Database: SQLite in data volume

Admin UI Settings

These settings are configured in Settings in the Admin UI:

Setting	Location
SMTP / Email	Settings → Email
GitHub integration	Settings → Integrations
Widget appearance	Settings → Widget
Branding	Settings → Branding
Rate limiting	Settings → Security
User management	Settings → Users

Environment Variables (Optional)

For advanced deployments, you can override defaults with environment variables in your docker-compose.yml.

Server Configuration

Variable	Default	Description
PORT	7300	Port the server listens on
HOST	0.0.0.0	Host to bind to
NODE_ENV	production	Environment mode
DATA_DIR	/data	Directory for database and uploads
SESSION_MAX_AGE	604800	Session duration in seconds (7 days)

Initial Admin Credentials

Variable	Default	Description
ADMIN_EMAIL	admin@example.com	Initial admin email
ADMIN_PASSWORD	changeme123	Initial admin password

These are only used when creating the first admin user. Change the password after first login.

SMTP (Alternative to Admin UI)

Variable	Description
SMTP_HOST	SMTP server hostname
SMTP_PORT	SMTP server port (default: 587)
SMTP_USER	SMTP username
SMTP_PASS	SMTP password
SMTP_FROM	From address for emails

GitHub Integration (Alternative to Admin UI)

Variable	Description
GITHUB_TOKEN	GitHub personal access token
APP_URL	Public URL (for webhooks and issue links)

Rate Limiting

Variable	Default	Description
RATE_LIMIT_MAX	10	Maximum requests per window
RATE_LIMIT_WINDOW	60	Window duration in seconds

File Uploads

Variable	Default	Description
MAX_FILE_SIZE	10485760	Maximum upload size in bytes (10MB)

Example: Custom Configuration

If you need to override defaults, add environment variables to your docker-compose.yml:

services:
  bugpin:
    image: harbor.arantic.digital/bugpin/bugpin:latest
    environment:
      - NODE_ENV=production
      - DATA_DIR=/data
      - ADMIN_EMAIL=admin@mycompany.com
      - ADMIN_PASSWORD=initial-secure-password
      - SMTP_HOST=smtp.mailgun.org
      - SMTP_PORT=587
      - SMTP_USER=postmaster@mg.mycompany.com
      - SMTP_PASS=smtp-password
      - SMTP_FROM=bugpin@mycompany.com
    # ... rest of configuration

tip

For most deployments, just use the default docker-compose.yml and configure everything in the Admin UI after installation.