docker-compose.yml

name: scancodeio
services:
  # This service checks the PostgreSQL data version before starting the database.
  # PostgreSQL major versions store data in incompatible formats, so starting
  # PostgreSQL 17 with data from PostgreSQL 13 would fail or cause corruption.
  #
  # The check reads the PG_VERSION file from the data volume (mounted read-only)
  # and blocks startup if the data is from an older PostgreSQL version.
  #
  # If this check fails, run the migration script before starting the stack:
  #   ./migrate-pg13-to-17.sh
  #
  # For fresh installations (no existing data), this check passes automatically.
  db-check:
    image: docker.io/library/postgres:17
    volumes:
      - db_data:/var/lib/postgresql/data/:ro
    entrypoint: [ "/bin/bash", "-c" ]
    command:
      - |
        DATA_DIR="/var/lib/postgresql/data"
        if [ ! -f "$$DATA_DIR/PG_VERSION" ]; then
          echo "Fresh install detected, no upgrade needed."
          exit 0
        fi

        OLD_VERSION=$$(cat "$$DATA_DIR/PG_VERSION")
        echo "Found PostgreSQL data version: $$OLD_VERSION"

        if [ "$$OLD_VERSION" -lt 17 ]; then
          echo ""
          echo "╔════════════════════════════════════════════════════════════════════╗"
          echo "║ ERROR: PostgreSQL $$OLD_VERSION data detected, version 17 required ║"
          echo "╠════════════════════════════════════════════════════════════════════╣"
          echo "║ Your database volume contains data from an older PostgreSQL.       ║"
          echo "║                                                                    ║"
          echo "║ To migrate, run:                                                   ║"
          echo "║    ./migrate-pg13-to-17.sh                                         ║"
          echo "║                                                                    ║"
          echo "╚════════════════════════════════════════════════════════════════════╝"
          echo ""
          exit 1
        fi

        echo "PostgreSQL version OK."
    restart: "no"

  db:
    image: docker.io/library/postgres:17
    depends_on:
      db-check:
        condition: service_completed_successfully
    env_file:
      - docker.env
    volumes:
      - db_data:/var/lib/postgresql/data/
    shm_size: "1gb"
    restart: always
    healthcheck:
      test: [ "CMD-SHELL", "pg_isready -U $${POSTGRES_USER} -d $${POSTGRES_DB}" ]
      interval: 10s
      timeout: 5s
      retries: 5

  redis:
    image: docker.io/library/redis:latest
    # Enable redis data persistence using the "Append Only File" with the
    # default policy of fsync every second. See https://redis.io/topics/persistence
    command: redis-server --appendonly yes
    volumes:
      - redis_data:/data
    restart: always

  web:
    build: .
    command: sh -c "
        ./manage.py migrate &&
        ./manage.py collectstatic --no-input --verbosity 0 --clear &&
        gunicorn scancodeio.wsgi:application --bind :8000 --timeout 600 \
          --workers 8 ${GUNICORN_RELOAD_FLAG:-}"
    env_file:
      - docker.env
    expose:
      - 8000
    volumes:
      - .env:/opt/scancodeio/.env
      - /etc/scancodeio/:/etc/scancodeio/
      - workspace:/var/scancodeio/workspace/
      - static:/var/scancodeio/static/
    depends_on:
      db:
        condition: service_healthy
      redis:
        condition: service_started

  worker:
    build: .
    # Ensure that potential db migrations run first by waiting until "web" is up
    command: wait-for-it --strict --timeout=600 web:8000 -- sh -c "
        ./manage.py rqworker --worker-class scancodeio.worker.ScanCodeIOWorker
                             --queue-class scancodeio.worker.ScanCodeIOQueue
                             --verbosity 1"
    env_file:
      - docker.env
    volumes:
      - .env:/opt/scancodeio/.env
      - /etc/scancodeio/:/etc/scancodeio/
      - workspace:/var/scancodeio/workspace/
    depends_on:
      - redis
      - db
      - web

  nginx:
    image: docker.io/library/nginx:alpine
    ports:
      - "${NGINX_PUBLISHED_HTTP_PORT:-80}:80"
      - "${NGINX_PUBLISHED_HTTPS_PORT:-443}:443"
    volumes:
      - ./etc/nginx/conf.d/:/etc/nginx/conf.d/
      - /var/www/html:/var/www/html
      - static:/var/scancodeio/static/
    depends_on:
      - web
    restart: always

  clamav:
    image: docker.io/clamav/clamav:latest
    volumes:
      - clamav_data:/var/lib/clamav
      - workspace:/var/scancodeio/workspace/
    restart: always

volumes:
  db_data:
  redis_data:
  clamav_data:
  static:
  workspace: