Note: Installations to Heroku require a local machine with some flavour of unix, as NodeBB does not run on Windows.

  1. Download and install Heroku Toolbelt for your operating system

  2. Log into your Heroku account: heroku login

  3. Verify your Heroku account by adding a credit card (at http://heroku.com/verify). Required for enabling Redis To Go Add-on.

  4. Clone the repository: git clone -b v1.5.x https://github.com/NodeBB/NodeBB.git /path/to/repo/clone

  5. cd /path/to/repo/clone

  6. Install dependencies locally npm install --production

  7. Create the heroku app: heroku create

  8. Enable Redis To Go for your heroku account (Nano is a free plan): heroku addons:create redistogo:nano

  9. 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 adjective-noun-wxyz.herokuapp.com
    • 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: redis://redistogo:h28h3wgh37fns7@fishyfish.redistogo.com:12345/
    • The server is fishyfish.redistogo.com
    • The port is 12345
    • The password is h28h3wgh37fns7
  10. Create a Procfile for Heroku: echo "web: node loader.js --no-daemon" > Procfile

  11. Commit the Procfile:

git add -f Procfile config.json package.json && git commit -am "adding Procfile and configs for Heroku"
  1. 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!
  2. Initialise a single dyno: heroku ps:scale web=1
  3. 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:

  1. Navigate to your repository at /path/to/nodebb
  2. git pull
  3. npm install
  4. node app --upgrade
  5. git commit -am "upgrading to latest nodebb"
  6. git push