1
Step 1Open the server Apps tab
Select your VPS, open the Apps tab, and start a new app deployment. Keep sensitive server details hidden before capturing or sharing screenshots.
Back to all templates
NodeBB
Application512MB+ RAM
Modern forum software built on Node.js
forumcommunitynodejs
Deploy NodeBB in 3 Steps
1
Connect Your VPS
Add your server credentials to Server Compass
2
Select NodeBB
Choose from our template library
3
Deploy & Configure
Fill in settings and click Deploy
No Docker knowledge required
Step-by-step deployment guide
Deploy NodeBB on a VPS with Server Compass
Use the NodeBB template in Server Compass to deploy a self-hosted Node.js forum platform with persistent NodeBB, upload, and MongoDB volumes on your VPS, then verify the NodeBB web UI in a browser.
About 7 minutesBrowser verified
2
Step 2Choose an app template
Click New App and choose the template deployment path so Server Compass can load the built-in catalog.
3
Step 3Search for NodeBB
Use the template picker search to find NodeBB in the Server Compass template catalog.
4
Step 4Select the NodeBB template
Choose the NodeBB template. Server Compass fills the NodeBB image, host port, published server URL, and persistent NodeBB, upload, and MongoDB volumes.
5
Step 5Review the NodeBB settings
Confirm the app name and compose services. In this run, the app was named nodebb-demo and used host port 4567.
6
Step 6Deploy NodeBB
Review the generated environment values, confirm the port is available, and click Deploy Now.
7
Step 7Watch the deployment progress
Keep the deployment modal open while Server Compass uploads the compose file, pulls the NodeBB image, starts the container, and verifies the stack.
8
Step 8Confirm NodeBB is running
After deployment finishes, return to the Apps tab and confirm the NodeBB app is marked Running with its application URL available.
9
Step 9Open NodeBB in the browser
Open the application URL in a browser. The NodeBB web UI confirms the site is reachable.
After NodeBB Opens
- Complete the NodeBB web installer before production use.
- Configure categories, users, themes, plugins, and outbound email before inviting users.
- Add a domain and HTTPS before exposing the forum to users.
- Back up the NodeBB and MongoDB volumes before relying on the forum for production communities.
NodeBB deployment questions
What does the NodeBB template deploy?
It deploys the NodeBB forum container with MongoDB plus persistent build, upload, and database volumes.
Which port did the tutorial use?
The tutorial used host port 4567, which maps to the NodeBB web server on container port 4567.
Why does the guide stop at the first-run web UI?
The tutorial verifies the clean first-run web UI because real library paths, users, metadata providers, and remote access settings depend on the production server.
Should this become a blog post?
No. The deployment guide should live on the NodeBB template detail page and be linked from the reusable template deployment docs page.
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.
1
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
2
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/nodebb3
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 URL4
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=1005
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:4567Skip 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
1
Complete web installer
2
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.
Ready to Self-Host NodeBB?
Download Server Compass and deploy NodeBB to your VPS in under 3 minutes. No Docker expertise required.
Download Server Compass