Skip to content

README.md

Latest commit

 

History

History
65 lines (48 loc) · 2.61 KB

README.md

File metadata and controls

65 lines (48 loc) · 2.61 KB
Raw

TripleA Forums (NodeBB)

The TripleA Forums run NodeBB, backed by Postgres, packaged as a Docker image built from this directory's Dockerfile and install/package.json + package-lock.json.

Running locally

The whole local stack (NodeBB + Postgres) is the repo's docker-compose.yml, driven by just:

just up

See docs/runbooks/run-forums-locally.md for the full flow — the admin login, connecting to the local database, and troubleshooting.

Production

Production is built and deployed by CI on push to master: the Publish Docker Image workflow builds this image, publishes it as ghcr.io/triplea-game/forums/nodebb:latest, and deploys it. The host side (the compose file, config.json, Postgres, secrets) is owned by the forums role in triplea-game/infrastructure, not this repo.

To move NodeBB to a new version, follow docs/runbooks/upgrade-nodebb.md — it is the source of truth for the bump-and-ship procedure and its gotchas.

Configuration

NodeBB is configured by a JSON file, config.json. The tracked example/config.json is the local-dev template (Postgres, localhost); the production file is rendered by the infrastructure forums role. NodeBB's own reference for every option is here.

Points worth knowing:

  • url is the address NodeBB serves — locally http://localhost:4567, in prod the public https URL.
  • port is the port inside the container; Docker maps a host port onto it.
  • The postgres block (host, port, username, password, database) is the database connection. host is the Postgres service name on the Docker network, not the host machine.
  • NodeBB rewrites config.json on setup and on boot, so the file must be writable — never mount it :ro.

NodeBB version

This is the NodeBB version the forums currently run; the README and install/package.json are written to it.

TripleA Forums NodeBB Version Package Json
Current 4.15.2 source

Plugins

NodeBB customizations are plugins, installed by pinning them in install/package.json (the nodebb-plugin-* and nodebb-theme-* entries), running just lock, and rebuilding the image. That file is the authoritative list. Today it is byte-identical to NodeBB's own install/package.json: every plugin and theme the forums run is one NodeBB bundles, so a version bump is a straight copy of upstream plus a lock regeneration (see docs/runbooks/upgrade-nodebb.md).