This repository builds and publishes the official Docker images for SignalDeck.
Images are automatically built and published to GitHub Container Registry (GHCR).
Base runtime image for most SignalDeck setups.
Includes:
- signaldeck-core
- signaldeck-sdk
- signaldeck-ui
- signaldeck-plugin-main
- gunicorn
- debugpy
Image:
ghcr.io/signaldeck/signaldeck
Extended image including the energy plugin.
Includes everything from signaldeck plus:
- signaldeck-plugin-energy
Image:
ghcr.io/signaldeck/signaldeck-energy
Example:
docker pull ghcr.io/signaldeck/signaldeck:latest
or
docker pull ghcr.io/signaldeck/signaldeck-energy:latest
Images are automatically versioned based on Git tags.
Example:
Git tag:
v0.3.0
Produces images:
ghcr.io/signaldeck/signaldeck:0.3.0 ghcr.io/signaldeck/signaldeck-energy:0.3.0
The default branch also publishes:
latest
Images are built for:
- linux/amd64
- linux/arm64
This allows running SignalDeck on:
- x86 servers
- Macs
- Raspberry Pi 4 / 5
Docker automatically pulls the correct architecture.
Example:
docker run -p 5000:5000 \ -e SIGNALDECK_MODE=dev \ -e SIGNALDECK_CONFIG=/config/demo.json \ -e SIGNALDECK_TEMPLATES=/templates \ ghcr.io/signaldeck/signaldeck
Environment variables:
SIGNALDECK_MODE=dev
Optional debugging:
SIGNALDECK_DEBUG=true
This enables debugpy on port 5555.
Production runs using gunicorn.
Default configuration:
workers: 1 threads: 4
Application port:
5000
Build base image:
docker build --target signaldeck -t signaldeck .
Build energy image:
docker build --target signaldeck-energy -t signaldeck-energy .
Dockerfile
docker/ docker-entrypoint.sh
.github/workflows/ docker.yml
GitHub Actions automatically:
- builds Docker images
- creates multi-architecture images
- pushes images to GHCR
- tags releases
Same license as the SignalDeck project.