Files
DorkNet/docs/advanced-setup.md
T
Alexa bcc5fe1bcb Add initial documentation and structure for DorkNet project
- Create README.md for project overview and setup instructions
- Add admin-ui/README.md for admin UI details and development setup
- Introduce client-mod/README.md explaining the MelonLoader mod functionality
- Establish docker/README.md for Docker setup and configuration
- Create docs/README.md to index project documentation
- Implement advanced-setup.md for Docker stack configuration
- Document architecture in architecture.md
- Provide easy-setup.md for hosting instructions
- Add FAQ.md for common questions and legal considerations
- Create joining-a-server.md for player connection instructions
- Establish troubleshooting.md for common issues and resolutions
- Introduce easy-app/README.md for the unified desktop application
- Add server/README.md for ASP.NET Core backend details
- Document tools/README.md for CLI helper scripts
2026-05-21 13:26:46 +03:00

3.8 KiB

Advanced mode — Docker stack

For hosts running a community server (more than ~10 concurrent players), doing custom modding work, or contributing to DorkNet itself.

If you just want to play with friends, the easy-setup desktop app is what you want.

What you get

  • server: the ASP.NET Core backend
  • postgres: the canonical store (the desktop app uses SQLite; for >10 concurrent players, Postgres is what you want)
  • redis: cross-replica presence cache (skip with REDIS_URL= empty to fall back to in-memory; loses presence on restart but otherwise fine)
  • nginx: TLS termination + multi-subdomain routing (api.*, auth.*, accounts.*, match.*, chat.*, cdn.*, commerce.*, img.*, leaderboard.*, notify.*)

Behind a proper TLS certificate (Let's Encrypt via Caddy or Cloudflare Tunnel) this should comfortably run 50+ concurrent players on a $20/mo VPS.

Prerequisites

  • A Linux VPS (Debian 12 / Ubuntu 22.04 / etc.)
  • A domain you control with wildcard DNS pointing at the VPS (*.your-server.example.com → 1.2.3.4)
  • Docker + Docker Compose

Setup

git clone https://github.com/YOUR_GH_USERNAME/dorknet
cd dorknet/docker

cp .env.example .env
$EDITOR .env  # fill in the values noted below

Required .env values

# Your domain. Server expects to find itself at *.DORKNET_DOMAIN.
DORKNET_DOMAIN=your-server.example.com

# A long random string. Used to sign JWTs.
JWT_SECRET=$(openssl rand -base64 64)

# Postgres password. Random, written once, kept in this file.
POSTGRES_PASSWORD=$(openssl rand -base64 32)

# Photon Cloud AppIds. Free tier at https://dashboard.photonengine.com
PHOTON_APP_ID=your-photon-realtime-appid
PHOTON_VOICE_APP_ID=your-photon-voice-appid  # optional
PHOTON_CLOUD_REGION=eu  # eu, us, asia, jp, sa, kr, in, au, etc.

# Steam Web API key — only needed if you want Steam logins to work.
# Free at https://steamcommunity.com/dev/apikey
STEAM_API_KEY=

TLS

The bundled nginx config terminates TLS but expects certificates to exist on the host. You have two reasonable paths:

  1. Caddy in front (recommended for new hosts) — replace the nginx service with a Caddyfile; Caddy auto-fetches Let's Encrypt certs.
  2. Cloudflare Tunnel — DNS your wildcard at Cloudflare, run cloudflared as another container, never expose port 443 to the internet. The repo includes a sample docker-compose.cloudflared.yml.

Run it

docker compose up -d
docker compose logs -f server

First boot does:

  1. Schema initialization (EnsureCreated from the entity classes)
  2. Legacy data upgrades (no-op on a fresh install)
  3. Seeds RR-Original rooms + store catalog
  4. Applies canonical room overrides (Crescendo, Paintball merge, etc.)
  5. Downloads the bundled room thumbnail images

You should see [boot] migrations complete within ~3 seconds. Then the server is ready at https://api.your-server.example.com/healthz.

Patching the client to point here

Same patcher as Easy mode, but you'll run it from the command line:

.\tools\patch-client.ps1 `
  -RecRoomDir "C:\path\to\Recroom_Release" `
  -ServerHost "your-server.example.com" `
  -PhotonAppId "your-photon-realtime-appid" `
  -PhotonRegion "eu"

Admin UI

https://admin.your-server.example.com — log in with the first account you create (it auto-promotes to admin) or with the bootstrap credentials in your .env if you set BOOTSTRAP_ADMIN_*.

Backups

Postgres is the only stateful service.

docker compose exec postgres pg_dump -U dorknet dorknet > backup.sql

data/images/ on the host is the image blob store. Back that up too.

Updating

cd dorknet
git pull
docker compose pull
docker compose up -d

The server runs all idempotent migrations on boot, so version upgrades are zero-downtime as long as the schema changes are additive.