Self-host NodeBB with Levelrail

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

  • AuthorNodeBB
  • LicenceGPL-3.0
  • Memory512 MiB
  • Archarm64
  • Services2

How to self-host NodeBB

  1. Pull the images

    2 images are pulled on your server.

    Show images
    • ghcr.io/nodebb/nodebb:latest
    • postgres:16-alpine
  2. Create the app

    2 services start in a single Compose app, with 4 named volume mounts for your data, on port 4567.

  3. Fill in the secrets

    2 secrets are generated and stored encrypted, 2 settings are preset, you do not have to fill in anything.

  4. Open it

    Without a domain the app gets an sslip.io address; add --domain SERVICE=HOST to use your own.

NodeBB requirements

Memory
About 512 MiB
Architectures
amd64 image published, arm64 image published
Ports
4567
Domain
Optional, an sslip.io address is used without one
Settings
none to fill in
License
GPL-3.0, copyleft license
  • Listed. It is in the catalog but not verified. Back up the data volume before changing an image tag.
  • Host ports. It publishes port 4567 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).

Install Levelrail first

On a server with Levelrail running, run the command above, or open the dashboard: Apps, New app, Browse templates, then NodeBB. New to Levelrail? Install it on a fresh VPS first.

docker pull ghcr.io/glincker/levelrail:latest

Then levelrail-cli login --device. See Getting started and the NodeBB docs page.

Deploy NodeBB your way

Every format below deploys the same pinned images. Pick the one that fits how you work.

Deploy NodeBB from the CLI

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

Deploy NodeBB with the API

Create a token in the dashboard first. This one-click route deploys it as a trial app you can keep or remove.

curl -X POST -H "Authorization: Bearer $TOKEN" \
  https://levelrail.example.com/api/v1/service-templates/nodebb/deploy

NodeBB configuration

NodeBB services

ServiceImagePortsVolumes
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

NodeBB environment variables

VariableServiceValue
POSTGRES_PASSWORD nodebb Generated at deploy
POSTGRES_DB postgres Preset by the template
POSTGRES_PASSWORD postgres Generated at deploy
POSTGRES_USER postgres Preset by the template

Ports and volumes

Ports
4567
Volumes
4 named mounts: nodebb_build -> /usr/src/app/build, nodebb_uploads -> /usr/src/app/public/uploads, nodebb_config -> /opt/config, nodebb_postgres_data -> /var/lib/postgresql/data

NodeBB FAQ

How much memory does NodeBB need?

The catalog lists about 512 MiB of memory for NodeBB across its 2 services.

Does NodeBB run on arm64?

For NodeBB, an arm64 image is published; amd64 is image published.

What licence is NodeBB under?

NodeBB is licensed under GPL-3.0, which is copyleft, so changes you distribute must be shared under the same terms.

Does NodeBB need configuration before it starts?

No. The template fills in its own defaults and generates secrets at deploy time.

Which database does NodeBB bundle?

The template includes Postgres, running as its own service.

Which ports does NodeBB use?

NodeBB listens on port 4567 inside the stack.

Where does NodeBB keep its data?

In named volumes: nodebb_build mounted at /usr/src/app/build, nodebb_uploads mounted at /usr/src/app/public/uploads, nodebb_config mounted at /opt/config and nodebb_postgres_data mounted at /var/lib/postgresql/data.

Can I deploy NodeBB on Dokploy or Dokku?

The services and pinned images on this page can be run on any Docker host. The public Dokploy templates list we compared does not have an entry with the same id for NodeBB, so on Dokploy you would use a Docker Compose application with the file from this page. Dokku deploys container images with its own commands, so the pinned image ghcr.io/nodebb/nodebb:latest, postgres:16-alpine is what you deploy there.

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