NodeBB

Application512MB+ RAM

Modern forum software built on Node.js

Download Server Compass View Documentation

forumcommunitynodejs

Deploy NodeBB in 3 Steps

Connect Your VPS

Add your server credentials to Server Compass

Select NodeBB

Choose from our template library

Deploy & Configure

Fill in settings and click Deploy

No Docker knowledge required

Do It Yourself

Deploy NodeBB via Command Line

Prefer the command line? Follow this step-by-step guide to deploy NodeBB manually on your VPS.

SSH into Your Server

Launch your preferred terminal and connect to your VPS using SSH.

terminal

# Log into your server
ssh root@<your-server-ip>

# If using key-based auth
ssh -i ~/.ssh/my-key root@<your-server-ip>

First time? Docker not installed? Run: curl -fsSL https://get.docker.com | sh

Create Working Directory

Prepare a directory for your application files and configuration.

terminal

# Create and navigate to project directory
mkdir -p ~/apps/nodebb
cd ~/apps/nodebb

Configure Your Containers

Create the Docker Compose configuration file with these contents:

docker-compose.yml

services:
  nodebb:
    image: nodebb/docker:latest
    ports:
      - "4567:4567"
    environment:
      - url=<your-url>
      - database=mongo
      - mongo__host=mongo
      - mongo__port=27017
      - mongo__database=nodebb
    volumes:
      - nodebb_data:/opt/nodebb/build
      - nodebb_uploads:/opt/nodebb/public/uploads
    restart: unless-stopped
    depends_on:
      - mongo

  mongo:
    image: mongo:6
    volumes:
      - mongo_data:/data/db
    restart: unless-stopped

volumes:
  nodebb_data:
  nodebb_uploads:
  mongo_data:

Configuration Variables

PORTHost port(default: 4567)

URLPublic URL

Deploy with Docker Compose

Launch the application stack using Docker Compose.

terminal

# Deploy the application
docker compose up -d

# Check container health
docker compose ps

# Monitor logs
docker compose logs -f --tail=100

Open Required Ports

Enable external access by opening the necessary port.

terminal

# Allow the application port through firewall
sudo ufw allow 4567/tcp
sudo ufw reload

# Access your app at:
# http://your-server-ip:4567

Skip the Terminal

There's an easier way. Meet Server Compass.

Deploy NodeBB with a beautiful UI instead. No SSH, no YAML editing, no terminal commands. Just click, configure, and deploy in under 3 minutes.

Intuitive dashboard
Deploy in 3 minutes
Free SSL included
Blue-green deploys
Real-time logs
Version history

Download Server Compass$29 one-time • Lifetime license

After Deployment

After deploying NodeBB with Server Compass, complete these steps to finish setup

Complete web installer

Configure categories

Need help? Check out our documentation for detailed guides.

NodeBB FAQ

Common questions about self-hosting NodeBB

How do I deploy NodeBB with Server Compass?

Simply download Server Compass, connect to your VPS, and select NodeBB from the templates list. Fill in the required configuration and click Deploy. The entire process takes under 3 minutes.

What are the system requirements for NodeBB?

NodeBB requires a minimum of 512MB RAM. We recommend a VPS with at least 1024MB RAM for optimal performance. Any modern Linux server with Docker support will work.

Can I migrate my existing NodeBB data?

Yes! Server Compass provides volume mapping that allows you to import existing data. You can also use standard NodeBB backup and restore procedures.

How do I update NodeBB to the latest version?

Server Compass makes updates easy. Simply click the Update button in your deployment dashboard, and the latest NodeBB image will be pulled and deployed with zero downtime.

Is NodeBB free to self-host?

NodeBB is open-source software. You only pay for your VPS hosting (typically $5-20/month) and optionally Server Compass ($29 one-time). No subscription fees or per-seat pricing.