Sign Up for Free

RunKit +

Try any Node.js package right in your browser

This is a playground to test code. It runs a full Node.js environment and already has all of npm’s 1,000,000+ packages pre-installed, including nodebb-backup with all npm packages installed. Try it out:

var nodebbBackup = require("nodebb-backup")

This service is provided by RunKit and is not affiliated with npm, Inc or the package authors.

nodebb-backup v0.1.2

A simple backup script based on


A simple backup script based on the steps described in


npm install -g nodebb-backup

Run (inside your nodebb folder)



  • Backs up the mongo database specified in NodeBB's config.json file
  • Backs up the nodebb/uploads directory which contains uploaded images
  • Compresses dumped db and files from /uploads into a tar with a format like this: nodebb-backup-2015-09-01_1509-v0.7.3.tar
  • Resulting tar file is saved to the directory above nodebb


  • Many, it's pretty raw!
  • Mongo only
  • No command line options yet

Needed Features (please send me feedback)

  • Be able to provide a path to place the resulting back up file
  • Redis support
  • Maybe be able to restore from a provided tar file?

Unpacking tar to new directory, 'unpackeddir'

mkdir -p unpackeddir; tar -xvf nodebb-backup-2015-11-10_1532-v0.8.2.tar -C $_

Restoring db (from inside unpacked directory created above)

mongorestore -d nodebb -u username -p password --dir=unpackeddir/nodebb --host=

RunKit is a free, in-browser JavaScript dev environment for prototyping Node.js code, with every npm package installed. Sign up to share your code.
Sign Up for Free