Installation
Follow nodebb.org's instructions for setting up an install of nodebb.
Select to use MongoDB for your database. You may restore the database after setup.
Restoring a production database
Should you choose to restore a database, you may download one in the NodeBB Admin.
This is not necessary if you're working with a clean data environment. However, if you've restored an API database with users, this step is highly recommended.
To retrieve a production database and restore it:
-
In NodeBB admin, select "PLUGINS" -> "SAAS" https://take.ms/6mt1hS
-
Select "DOWNLOAD BACKUP" https://take.ms/lfjH1
-
Use mongorestore
to restore the database locally
mongorestore -u <username> -p <password> -d <database> -c <collection>
!!! IMPORTANT !!! Turn off notification & digest emails
ENSURE THAT IF YOU'VE CHOSEN A PRODUCTION DATABASE, PLEASE TURN OFF DIGESTS IN THE NODEBB ADMIN IMMEDIATELY FOLLOWING RESTORATION.
- In NodeBB admin, select "SETTINGS" -> "EMAIL" https://take.ms/TBhrvf
- Scroll down to "Email Subscriptions"
- Turn "Disable subscriber notification emails" ON. https://take.ms/ZkOoG
Install required plugins
After installation is complete, install the following plugins with npm:
- Write API
- Friends
- Session Sharing
- S3 Uploads
Installation is done in the nodebb directory with the commands:
npm install git+https://git@github.com/sanbornmedia/nodebb-plugin-write-api --save
npm install git+https://git@github.com/sanbornmedia/nodebb-plugin-friends --save
npm install git+https://git@github.com/sanbornmedia/nodebb-plugin-session-sharing --save
npm install git+https://git@github.com/sanbornmedia/nodebb-plugin-s3-uploads --save
Alternatively, add this to the nodebb's package.json:
"nodebb-plugin-friends": "git+https://git@github.com/sanbornmedia/nodebb-plugin-friends",
"nodebb-plugin-s3-uploads-updated": "git+https://git@github.com/sanbornmedia/nodebb-plugin-s3-uploads.git",
"nodebb-plugin-session-sharing": "git+https://git@github.com/sanbornmedia/nodebb-plugin-session-sharing.git",
"nodebb-plugin-write-api": "git+https://git@github.com/sanbornmedia/nodebb-plugin-write-api",
Install this theme with npm, i.e.,
Note: You must be logged into an npm account that is a member of the Sanborn Agency org.
npm install @sanbornagency/nodebb-theme-quest --save
Updating the theme
Note: You must be logged into an npm account that is a member of the Sanborn Agency org.
Increment version number in package.json
and run npm publish
in project root.
Running Node BB
Start redis using the command redis-server
to start, and redis-cli shutdown
to stop it.
In the nodebb directory, run ./nodebb build
to build assets, templates, etc. Then run ./nodebb dev
to start the server with logging.
Notes
Template file names and directory structure must mirror the templates they're replacing in the Node BB directory, as Node BB's build process will use the theme's templates to overwrite the defaults.