Skip to main content

Docker Compose Installation

Overview​

Docker Compose provides an easy way to run PACKAGE.broker with all dependencies (database, cache, storage) in a single command.

Prerequisites​

  • Docker installed (version 20.10 or later)
  • Docker Compose (version 2.0 or later)
  • At least 4GB RAM available
  • 20GB disk space for package storage

Production Setup​

A production-ready docker-compose.yml:

services:
  package-broker:
    image: packagebroker/server:latest
    ports:
      - "8080:8080"
    environment:
      DB_DRIVER: postgres
      DB_URL: postgres://user:pass@postgres:5432/packages
      CACHE_DRIVER: redis
      CACHE_URL: redis://redis:6379
      STORAGE_DRIVER: s3
      S3_ENDPOINT: minio:9000
      S3_BUCKET: packages
      ENCRYPTION_KEY: ${ENCRYPTION_KEY}
      # SMTP Configuration (Optional - uncomment to enable email sending)
      # SMTP_HOST: ${SMTP_HOST}
      # SMTP_PORT: ${SMTP_PORT:-587}
      # SMTP_USER: ${SMTP_USER}
      # SMTP_PASS: ${SMTP_PASS}
      # SMTP_FROM: ${SMTP_FROM}
    depends_on:
      - postgres
      - redis
      - minio

  postgres:
    image: postgres:16-alpine
    environment:
      POSTGRES_DB: packages
      POSTGRES_USER: user
      POSTGRES_PASSWORD: pass
    volumes:
      - postgres_data:/var/lib/postgresql/data

  redis:
    image: redis:7-alpine
    volumes:
      - redis_data:/data

  minio:
    image: minio/minio:latest
    command: server /data --console-address ":9001"
    environment:
      MINIO_ROOT_USER: minioadmin
      MINIO_ROOT_PASSWORD: minioadmin
    volumes:
      - minio_data:/data

volumes:
  postgres_data:
  redis_data:
  minio_data:

Configuration​

Environment Variables​

Create a .env file:

ENCRYPTION_KEY=$(openssl rand -base64 32)
DB_PASSWORD=your-secure-password
MINIO_ROOT_PASSWORD=your-secure-password

# SMTP Configuration (Optional)
# Uncomment and configure to enable email sending for user invitations
# SMTP_HOST=smtp.gmail.com
# SMTP_PORT=587
# SMTP_USER=your-email@gmail.com
# SMTP_PASS=your-app-password
# SMTP_FROM=noreply@example.com

Starting Services​

docker-compose up -d

Accessing Services​

Alternative Image Sources​

You can also use the GitHub Container Registry image:

services:
  package-broker:
    image: ghcr.io/package-broker/server:latest

SMTP Configuration (Optional)​

To enable email sending for user invitations, configure SMTP settings:

  1. Add SMTP variables to your .env file (see Environment Variables above)
  2. Uncomment the SMTP environment variables in docker-compose.yml
  3. Restart the container: docker-compose restart package-broker

Example for Gmail:

SMTP_HOST=smtp.gmail.com
SMTP_PORT=587
SMTP_USER=your-email@gmail.com
SMTP_PASS=your-app-specific-password
SMTP_FROM=your-email@gmail.com

Note: Gmail requires an app-specific password for SMTP. See Configuration Reference for other email provider examples.

Next Steps​

  1. Review the Docker Quickstart guide for detailed setup instructions
  2. Check the Cloudflare Workers Quickstart for serverless deployment options
  3. Review compliance documentation
  4. Configure SMTP for email notifications (see SMTP Configuration above)

Support​