Docker Deployment¶

PokéDex Scanner ships as a multi-stage Docker image. The final runtime image is based on node:22-alpine and serves both the pre-built React frontend and the Node.js API server on a single port.

Quick start¶

# Using the default GitHub Models provider
docker run -d \
  --name pokedex-scanner \
  -e AI_PROVIDER=github \
  -e GITHUB_MODELS_TOKEN="ghp_..." \
  -v pokedex-data:/data \
  -p 8787:8787 \
  ghcr.io/pacorreia/pokemon-card-scanner:latest

Open http://localhost:8787.

Docker Compose¶

services:
  pokedex-scanner:
    image: ghcr.io/pacorreia/pokemon-card-scanner:latest
    restart: unless-stopped
    environment:
      AI_PROVIDER: github
      GITHUB_MODELS_TOKEN: "${GITHUB_MODELS_TOKEN}"
      # Optional: protect mutating endpoints with a password
      # API_SECRET: "${API_SECRET}"
    volumes:
      - pokedex-data:/data
    ports:
      - "8787:8787"
      # HTTPS is also available on 8443 (self-signed certificate)
      # - "8443:8443"

volumes:
  pokedex-data:

Start:

export GITHUB_MODELS_TOKEN="ghp_..."
docker compose up -d

Stop:

docker compose down

Available image tags¶

Images are hosted in the GitHub Container Registry.

Volumes¶

Ports¶

Environment variables¶

See Environment Variables for the full list. At minimum, set AI_PROVIDER and the required provider-specific variables. See AI Providers for all supported providers and their required variables.

Building the image locally¶

git clone https://github.com/pacorreia/pokemon-card-scanner.git
cd pokemon-card-scanner
docker build -t pokedex-scanner .
# Using the default GitHub Models provider
docker run -d \
  --name pokedex-scanner \
  -e AI_PROVIDER=github \
  -e GITHUB_MODELS_TOKEN="ghp_..." \
  -v pokedex-data:/data \
  -p 8787:8787 \
  pokedex-scanner

HTTPS configuration¶

HTTPS is enabled by default on port 8443 with an auto-generated self-signed certificate. For production use behind a reverse proxy (e.g., nginx, Traefik, Caddy), expose only port 8787 and let the proxy handle TLS termination.