Server deployment
Docker or plain Node.
One Node process and one SQLite file, behind HTTPS. Remote help needs it online; keep it small and backed up.
01Docker
Run the shell commands on this page in WSL 2 (Ubuntu), not in PowerShell: install Node.js inside WSL for the server commands. Flutter can also run natively on Windows for Android builds; iOS builds need a Mac. macOS and Linux users can ignore this note.
cd server
cp .env.example .env # set ADMIN_SECRET_KEY
docker build -t hometether-server .
docker run -p 8787:8787 -v hometether-data:/app/data --env-file .env hometether-server
The volume holds the databases. The image is based on node:26-bookworm-slim, runs as the node user, listens on 8787 and has a health check on /healthz. The Dockerfile is included; the author did not run a Docker build for this documentation (unverified), so test it once.
02Plain Node 26 (VPS, PM2, systemd)
- Install Node 26 LTS (22.12 or newer works).
- On the server:
cd server npm ci npm run build - Run
node dist/src/index.jswith the variables from Configuration, under PM2 or a systemd unit so it restarts. - Put it behind HTTPS and pass WebSocket upgrades (Relay) and set
TRUST_PROXY_HOPS=1. - Build the app with
--dart-define=API_BASE_URL=https://your-domain.
SQLite is one file on one disk, and relay sessions live in the memory of the process. Do not run several copies against the same data, and avoid hosts with no persistent disk.
03Backups
Back up the data/ folder (the SQLite files) and your ADMIN_SECRET_KEY.
04Production security
- HTTPS and WSS only, for the relay and for the console (it carries the sign-in cookie). Turn on two-factor sign-in for every team member.
- Set
TRUST_PROXY_HOPS=1behind one proxy so limits see the real address. - The server limits
/v1routes to 60 requests a minute per address, counted in memory; add a limit at the proxy as well if you like. - Remove
ADMIN_SETUP_TOKENafter the owner exists. Keep.envandADMIN_SECRET_KEYout of version control. - Switch the relay off in the console to end every session at once if you need to.
05Stores
The app is published through App Store Connect and Google Play, see Release. There is no web version.