Node.js based forum software built for the modern web
Switch branches/tags
Clone or download
Permalink
Failed to load latest commit information.
.github update issue template to show postgres version command Sep 15, 2018
.tx added Latvian localisation strings Aug 27, 2018
build endpoint to download user attachments, #6441 Apr 13, 2018
install Merge branch 'master' of https://github.com/NodeBB/NodeBB Nov 12, 2018
logs added daemon capability to ./nodebb start, npm start/stop scripts Feb 27, 2014
public misc fixes Nov 12, 2018
src Merge branch 'master' of https://github.com/NodeBB/NodeBB Nov 12, 2018
test closes #6942 Nov 11, 2018
.codeclimate.yml tweak codeclimate settings Oct 21, 2018
.editorconfig Fix editorconfig syntax Jan 20, 2015
.eslintignore Support scoped theme packages Jun 11, 2018
.eslintrc style(eslint): enforcing newline on chained calls Nov 8, 2018
.gitattributes #3343 Jul 21, 2015
.gitignore Add build/export to repo Apr 12, 2018
.jsbeautifyrc format/jshint favourites.js Sep 18, 2013
.jshintrc update esversion Oct 22, 2018
.travis.yml Parse int (#6853) Oct 21, 2018
Dockerfile chore(deps): update node.js to v8.12.0 Nov 7, 2018
Gruntfile.js use includes instead of indexOf Oct 20, 2018
LICENSE Resolving issue #2 -- added GPLv3 license file and updated package.json Jun 17, 2013
README.md Typo fixing(README) (#6681) Aug 1, 2018
app.js chore(deps): update dependency eslint-config-airbnb-base to v13 (#6599) Nov 7, 2018
commitlint.config.js feat: enabling commitlint Nov 8, 2018
loader.js Enable `require.main.require` in tests (#6896) Oct 31, 2018
nodebb CLI refactor with commander (#6058) Nov 23, 2017
nodebb.bat CLI refactor with commander (#6058) Nov 23, 2017
renovate.json Add renovate.json Jun 18, 2018
require-main.js Enable `require.main.require` in tests (#6896) Oct 31, 2018

README.md

NodeBB

Build Status Coverage Status Dependency Status Code Climate

NodeBB Forum Software is powered by Node.js and built on either a Redis or MongoDB database. It utilizes web sockets for instant interactions and real-time notifications. NodeBB has many modern features out of the box such as social network integration and streaming discussions, while still making sure to be compatible with older browsers.

Additional functionality is enabled through the use of third-party plugins.

Screenshots

NodeBB's theming engine is highly flexible and does not restrict your design choices. Check out some themed installs in these screenshots below:

Our minimalist "Persona" theme gets you going right away, no coding experience required.

How can I follow along/contribute?

  • If you are a developer, feel free to check out the source and submit pull requests. We also have a wide array of plugins which would be a great starting point for learning the codebase.
  • If you are a designer, NodeBB needs themes! NodeBB's theming system allows extension of the base templates as well as styling via LESS or CSS. NodeBB's base theme utilizes Bootstrap 3 but themes can choose to use a different framework altogether.
  • If you know languages other than English you can help us translate NodeBB. We use Transifex for internationalization.
  • Please don't forget to like, follow, and star our repo! Join our growing community to keep up to date with the latest NodeBB development.

Requirements

NodeBB requires the following software to be installed:

  • A version of Node.js at least 6 or greater (installation/upgrade instructions)
  • Redis, version 2.8.9 or greater or MongoDB, version 2.6 or greater
  • nginx, version 1.3.13 or greater (only if intending to use nginx to proxy requests to a NodeBB)

Installation

Please refer to platform-specific installation documentation

Securing NodeBB

It is important to ensure that your NodeBB and database servers are secured. Bear these points in mind:

  1. While some distributions set up Redis with a more restrictive configuration, Redis by default listens to all interfaces, which is especially dangerous when a server is open to the public. Some suggestions:
    • Set bind_address to 127.0.0.1 so as to restrict access to the local machine only
    • Use requirepass to secure Redis behind a password (preferably a long one)
    • Familiarise yourself with Redis Security
  2. Use iptables to secure your server from unintended open ports. In Ubuntu, ufw provides a friendlier interface to working with iptables.
    • e.g. If your NodeBB is proxied, no ports should be open except 80 (and possibly 22, for SSH access)

Upgrading NodeBB

Detailed upgrade instructions are listed in Upgrading NodeBB

License

NodeBB is licensed under the GNU General Public License v3 (GPL-3) (http://www.gnu.org/copyleft/gpl.html).

Interested in a sublicense agreement for use of NodeBB in a non-free/restrictive environment? Contact us at sales@nodebb.org.