Note: Installations to Heroku require a local machine with some flavour of unix, as NodeBB does not run on Windows.
- Download and install Heroku Toolbelt for your operating system
- Log into your Heroku account:
- Verify your Heroku account by adding a credit card (at http://heroku.com/verify). Required for enabling Redis To Go Add-on.
- Clone the repository:
git clone -b v1.5.x https://github.com/NodeBB/NodeBB.git /path/to/repo/clone
- Install dependencies locally
npm install --production
- Create the heroku app:
- Enable Redis To Go for your
heroku account (Nano is
a free plan):
heroku addons:create redistogo:nano
Run the NodeBB setup script:
node app --setup(information for your Heroku server and Redis to Go instance can be found in your account page)
- Your server name is found in your Heroku app's "settings"
page, and looks something like
- Use any port number. It will be ignored.
- Your redis server can be found as part of the redis url. For
example, for the url:
- The server is
- The port is
- The password is
- The server is
- Your server name is found in your Heroku app's "settings" page, and looks something like
Create a Procfile for Heroku:
echo "web: node loader.js --no-daemon" > Procfile
- Commit the Procfile:
git add -f Procfile config.json package.json build && git commit -am "adding Procfile and configs for Heroku"
- Push to heroku:
git push -u heroku v1.5.x:master
- Ensure that a proper SSH key was added to your account, otherwise the push will not succeed!
- Initialise a single dyno:
heroku ps:scale web=1
- Visit your app!
If these instructions are unclear or if you run into trouble, please let us know by creating a topic on the Community Support Forum.
Keeping it up to date
If you wish to pull the latest changes from the git repository to your Heroku app:
- Navigate to your repository at
node app --upgrade
git commit -am "upgrading to latest nodebb"