Files

T

branderson 4130adfe58 docs: document Dotcom Arcade, streaming, proxy sign-in and saves

A new README for the combined project with setup from the Flashpoint
Ultimate torrent. New feature docs for streaming, proxy sign-in and
game saves; deployment, upgrade and streaming READMEs updated for the
single compose file; the project renamed throughout.

2026-10-13 19:31:06 -07:00

3.7 KiB

Raw Blame History

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.
Memory: 4 GB of RAM. With streaming, allow about 1 GB more per concurrent stream, since each streamer container gets 1 GB of shared memory.
A Flashpoint install at FLASHPOINT_HOST_PATH, with Data/flashpoint.sqlite, Data/Games/, Data/Images/, Data/Playlists/ and Legacy/htdocs/. scripts/setup-flashpoint.sh produces 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; serves `/stream/` on port 8081
`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.

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: serves /stream/ on STREAM_PORT (default 8081).
dotcom-arcade network: the app and the session manager share it.
dotcom-arcade-streams network: 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 route /stream/ to the session manager (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_PATH doesn't point at a folder with Data/flashpoint.sqlite. Check with docker compose exec app ls /data/flashpoint/Data.
Missing playlists or settings: Data/Playlists or preferences.json is missing. Re-run scripts/setup-flashpoint.sh, which takes them from Base_1.zip, or add --with-infinity.
Permission errors on ./data or ./logs: set PUID/PGID to the owner of those folders.

3.7 KiB Raw Blame History