UpNext needs Redis and optionally PostgreSQL. Docker Compose is the easiest way to manage these services alongside the UpNext server.
Infrastructure services
Create a docker-compose.yml for your infrastructure:
services:
redis:
image: redis:7-alpine
ports:
- "6379:6379"
volumes:
- redis_data:/data
command: redis-server --appendonly yes
healthcheck:
test: ["CMD", "redis-cli", "ping"]
interval: 5s
timeout: 3s
retries: 3
postgres:
image: postgres:17-alpine
ports:
- "5432:5432"
environment:
POSTGRES_DB: upnext
POSTGRES_USER: upnext
POSTGRES_PASSWORD: upnext
volumes:
- postgres_data:/var/lib/postgresql/data
healthcheck:
test: ["CMD-SHELL", "pg_isready -U upnext -d upnext"]
interval: 5s
timeout: 3s
retries: 3
volumes:
redis_data:
postgres_data:
If you only need Redis (using SQLite for the dashboard database), you can skip the postgres service entirely and just run Redis.
Start UpNext
With infrastructure running, start the server and your services using the CLI:
Run database migrations (PostgreSQL only)
UPNEXT_DATABASE_URL=postgresql+asyncpg://upnext:upnext@localhost:5432/upnext \
upnext server db upgrade head
Start the dashboard server
UPNEXT_DATABASE_URL=postgresql+asyncpg://upnext:upnext@localhost:5432/upnext \
UPNEXT_REDIS_URL=redis://localhost:6379 \
UPNEXT_AUTH_ENABLED=true \
UPNEXT_API_KEY=changeme \
upnext server start --port 8080
UPNEXT_DATABASE_URL=sqlite+aiosqlite:///upnext.db \
UPNEXT_REDIS_URL=redis://localhost:6379 \
UPNEXT_AUTH_ENABLED=true \
UPNEXT_API_KEY=changeme \
upnext server start --port 8080
Start your worker and API
UPNEXT_REDIS_URL=redis://localhost:6379 \
UPNEXT_URL=http://localhost:8080 \
UPNEXT_API_KEY=changeme \
upnext run service.py
Environment variables
| Variable | Description |
|---|
UPNEXT_DATABASE_URL | PostgreSQL or SQLite connection string |
UPNEXT_REDIS_URL | Redis connection URL |
UPNEXT_AUTH_ENABLED | Enable API key authentication ("true" / "false") |
UPNEXT_API_KEY | API key for authentication |
UPNEXT_ARTIFACT_STORAGE_BACKEND | local or s3 |
Scale workers
To run multiple worker instances, use the replicas option in your Compose file or the --scale flag:
services:
worker:
build: .
command: upnext run service.py
environment:
UPNEXT_REDIS_URL: redis://redis:6379
deploy:
replicas: 3
# Or scale on the fly
docker compose up -d --scale worker=3
Volumes
| Volume | Purpose |
|---|
redis_data | Redis AOF persistence |
postgres_data | PostgreSQL data files |
