docker-compose.example.yml

# Docker Compose configuration for Synkronus
# This setup includes:
# - Synkronus API server
# - PostgreSQL database
# - Nginx reverse proxy
#
# For production deployment:
# 1. Update all passwords and secrets
# 2. Configure nginx SSL certificates (or use cloudflared tunnel)
# 3. Mount one volume at /app/data: bundles, versions, attachments
# 4. Configure backup strategy

services:
  # Nginx reverse proxy
  nginx:
    image: nginx:alpine
    ports:
      - "80:80"
      - "443:443"
    volumes:
      - ./nginx.conf:/etc/nginx/nginx.conf:ro
      # Uncomment for SSL certificates:
      # - ./ssl:/etc/nginx/ssl:ro
    depends_on:
      - synkronus
    restart: unless-stopped
    healthcheck:
      test: ["CMD-SHELL", "wget --no-verbose --tries=1 -O - http://127.0.0.1/health || wget --no-verbose --tries=1 -O - http://localhost/health"]
      interval: 30s
      timeout: 3s
      retries: 3

  # Synkronus API server
  synkronus:
    # Use pre-built image from GitHub Container Registry
    image: ghcr.io/opendataensemble/synkronus:latest
    # Or build locally for development:
    # build:
    #   context: .
    #   args:
    #     SYNKRONUS_VERSION: ${SYNKRONUS_VERSION:-1.0.0}
    expose:
      - "8080"
    # Only expose port directly if not using nginx:
    # ports:
    #   - "8080:8080"
    environment:
      PORT: "8080"
      LOG_LEVEL: "info"
      # Database configuration - Update with your PostgreSQL credentials
      DB_CONNECTION: "postgres://synkronus_user:CHANGE_THIS_PASSWORD@postgres:5432/synkronus?sslmode=disable"
      # JWT Secret (MUST be changed in production!)
      # Generate with: openssl rand -base64 32
      JWT_SECRET: "CHANGE_THIS_TO_RANDOM_32_CHAR_STRING"
      ADMIN_USERNAME: "admin"
      ADMIN_PASSWORD: "CHANGE_THIS_ADMIN_PASSWORD"
      # Emergency recovery flow (optional):
      # If both values are set, Synkronus creates/overwrites this admin user at startup.
      # Remove after recovery so credentials are not reset on restart.
      # SYNKRONUS_RECOVERY_CREATE_USER: "admin"
      # SYNKRONUS_RECOVERY_CREATE_PASS: "TEMPORARY_RECOVERY_PASSWORD"
      MAX_VERSIONS_KEPT: "5"
    volumes:
      - synkronus_data:/app/data
    depends_on:
      - postgres
    restart: unless-stopped
    
    healthcheck:
      test: ["CMD-SHELL", "wget --no-verbose --tries=1 -O - http://127.0.0.1:8080/health || wget --no-verbose --tries=1 -O - http://localhost:8080/health"]
      interval: 30s
      timeout: 3s
      retries: 3
      start_period: 10s

  # PostgreSQL database
  postgres:
    image: postgres:17
    environment:
      # Root PostgreSQL user and password (used to create application databases)
      POSTGRES_USER: postgres
      POSTGRES_PASSWORD: CHANGE_THIS_PASSWORD
    volumes:
      - postgres-data:/var/lib/postgresql/data
    expose:
      - "5432"
    # Only expose port if you need external access:
    # ports:
    #   - "5432:5432"
    restart: unless-stopped
    healthcheck:
      test: ["CMD-SHELL", "pg_isready -U postgres"]
      interval: 10s
      timeout: 5s
      retries: 5

# Named volumes for data persistence
# These will persist data even if containers are removed

volumes:
  postgres-data:
  synkronus_data: