Self-host NodeBB on a VPS

A modern forum platform with real-time discussions, SSO, and a plugin ecosystem, backed by Postgres.

levelrail-cli templates deploy nodebb --name my-nodebb

Specification

Status
Listed
Category
Communication
Services
nodebb, postgres
Ports
4567
Volumes
4
Memory
about 512 MiB
arm64
image published
amd64
image published
Settings to fill in
none

About NodeBB

A modern forum platform with real-time discussions, SSO, and a plugin ecosystem, backed by Postgres. Runs 2 containers (nodebb, postgres), with nodebb listening on port 4567; data is kept in named volumes.

What it deploys

NodeBB runs as 2 services in a single Compose app, listening on port 4567, with 4 named volume mounts.

ServiceImageTagPortsVolumes
nodebb ghcr.io/nodebb/nodebb latest 4567 nodebb_build -> /usr/src/app/buildnodebb_uploads -> /usr/src/app/public/uploadsnodebb_config -> /opt/config
postgres postgres 16-alpine none nodebb_postgres_data -> /var/lib/postgresql/data

Before you install

  • CPU architecture. arm64 listed. Every image lists linux/arm64 in its registry manifest. That is a manifest fact, not proof the app runs on Arm.
  • Listed. It is in the catalog. Back up the data volume before changing an image tag.
  • Host ports. It publishes port 4567 directly on the host, so open them in the VPS firewall only if you want that.
  • Review. Image is not pinned to a version tag, so a redeploy can pull different code (ghcr.io/nodebb/nodebb:latest).

Settings and environment

You do not have to fill in anything. 2 secrets are generated at deploy and stored encrypted. Values are never shown here.

ServiceVariableValue
nodebbPOSTGRES_PASSWORDGenerated at deploy
postgresPOSTGRES_DBPreset by the template
postgresPOSTGRES_PASSWORDGenerated at deploy
postgresPOSTGRES_USERPreset by the template

Install NodeBB on a VPS

  1. Install Levelrail on a fresh VPS

    Run this as root on a Linux server (amd64 or arm64) with ports 80 and 443 reachable. The installer prints a setup link.

    curl -fsSL https://levelrail.com/install.sh | sudo sh
  2. Sign in

    Open the setup link, choose a password, then log the CLI in. The CLI install command is curl -fsSL https://levelrail.com/install-cli.sh | sh if the machine does not have it. See Getting started.

    levelrail-cli login --device
  3. Read the template

    Shows the entry, including its full compose.yaml.

    levelrail-cli templates get nodebb
  4. Deploy it

    This deploys the template compose file as an app. The app name defaults to the template id; --name sets another.

    levelrail-cli templates deploy nodebb --name my-nodebb

Without a domain the app gets an sslip.io address. You can also deploy it from the dashboard: Apps, New app, Browse templates, then NodeBB.

More in Communication

All Communication templates