Docker Compose (Recommended)

The project includes a docker-compose.yml that starts flux + Redis:

docker compose up -d

This starts:

• flux on port 8080
• Redis 7 on port 6379

Public Image (Pull & Run)

The flux image is published to GitHub Container Registry — no authentication needed:

docker run -e REDIS_ADDR=host.docker.internal:6379 -p 8080:8080 ghcr.io/xinnaider/flux

Pull a specific version:

docker pull ghcr.io/xinnaider/flux
docker pull ghcr.io/xinnaider/flux:<sha>

Docker Build

Build the image locally from source:

docker build -t flux .
docker run -p 8080:8080 --network host flux

Docker Compose Customization

services:
  flux:
    build: .
    ports:
      - "8080:8080"
    environment:
      - REDIS_ADDR=redis:6379
      - HEARTBEAT_TTL=30s
    depends_on:
      - redis

  redis:
    image: redis:7-alpine
    ports:
      - "6379:6379"
    volumes:
      - redis-data:/data

volumes:
  redis-data: