branderson
97168ea0e5
Drops version tag builds and the main tag. Images report the short commit SHA as their version.
5.3 KiB
Docker Deployment
Deploy Dotcom Arcade with Docker Compose. The README walks through a first install; this page covers the details.
Prerequisites
- Docker: Engine 24+ with the Compose plugin.
- Storage: more than 2.3 TB for Flashpoint Ultimate 14, or 4.6 TB to keep the downloaded archives.
- CPU and memory: 2 cores and 4 GB of RAM for the site. Streaming adds roughly 1 to 2 CPU cores and 1 GB of RAM per player streaming at once, since each player's container runs the game and encodes its video on the CPU.
- A Flashpoint install at
FLASHPOINT_HOST_PATH, withData/flashpoint.sqlite,Data/Games/,Data/Images/,Data/Playlists/andLegacy/htdocs/.scripts/setup-flashpoint.shproduces one from the Flashpoint Ultimate torrent.
Services
| Service | Image | Profile | Purpose |
|---|---|---|---|
app |
dotcom-arcade |
(always) | UI, API and game content on port 3100 |
session-manager |
dotcom-arcade-session-manager |
streaming |
Starts streamer containers and serves their streams, through the app |
streamer |
dotcom-arcade-streamer |
streaming |
Built only; the session manager runs one per player |
All three are built from this repository by docker compose up -d --build.
Prebuilt images
Images are published to GitHub's container registry. To pull them instead of
building, set IMAGE_PREFIX in .env, ending in /. There's one tag,
latest, built from the tip of main.
IMAGE_PREFIX=ghcr.io/branderson/
Then run docker compose pull && docker compose up -d. Images from another
registry work the same way, with its path as the prefix.
Publishing images
Two workflows build the same images with the same tags:
.github/workflows/images.ymlruns on the GitHub mirror and pushes toghcr.io/<owner>/with the workflow's own token. It needs no setup..gitea/workflows/images.ymlruns on the forge. Gitea ignores.github/workflowswhile.gitea/workflowsexists.
.gitea/workflows/images.yml builds all three images on Gitea Actions and
pushes them to the Gitea instance's container registry, under the repository's
owner. Each push to main publishes latest. Its jobs run docker builds, so they need a runner labelled
dejima-privileged; jobs that don't build images should use dejima-confined.
It also needs a repository secret, REGISTRY_TOKEN: an access token with
package write access, belonging to the repository's owner, whom the workflow
logs in as. If the runner reaches Gitea at a different address than the
registry's public one, set a repository variable REGISTRY_HOST to the
registry's host name.
Volumes
| Host | Container | Purpose |
|---|---|---|
FLASHPOINT_HOST_PATH |
/data/flashpoint |
The Flashpoint install. Read-write: downloaded game data and download state are recorded there |
DATA_PATH (./data) |
/app/data |
user.db and the installed Ruffle. Back this up |
LOGS_PATH (./logs) |
/app/logs |
Log files |
The session manager mounts the Flashpoint install read-only and the Docker
socket, and passes FLASHPOINT_HOST_PATH on to the streamer containers.
Ports and networks
- App: listens on
WEB_PORT(default 80) on the host. - Session manager: publishes no ports. The app proxies
/stream/to it. dotcom-arcadenetwork: the app and the session manager share it.dotcom-arcade-streamsnetwork: holds the streamer containers. It's internal, so they have no internet access and only the session manager can reach them.
Put a reverse proxy with HTTPS in front of the app. Streaming needs HTTPS, and the proxy must pass WebSocket upgrades (see Streaming).
Health checks
The app reports starting at /health until its database copy and cache
pre-warm finish, which can take minutes on network storage. The compose file
allows 5 minutes before counting failures.
docker compose ps
docker inspect dotcom-arcade --format '{{json .State.Health}}'
Logs
docker compose logs -f app
docker compose logs -f session-manager
Troubleshooting
- "Source database not found":
FLASHPOINT_HOST_PATHdoesn't point at a folder withData/flashpoint.sqlite. Check withdocker compose exec app ls /data/flashpoint/Data. - Missing playlists or settings:
Data/Playlistsorpreferences.jsonis missing. Re-runscripts/setup-flashpoint.sh, which takes them fromBase_1.zip, or pass--infinity. - Permission errors on
./dataor./logs: setPUID/PGIDto the owner of those folders.