Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Node.js based forum software built for the modern web
JavaScript Smarty CSS
Failed to load latest commit information.
.tx added Bulgarian to NodeBB, благодаря!
install added one more line to stdout when nodebb status is invoked, or nodeb…
logs added daemon capability to ./nodebb start, npm start/stop scripts
public updated to latest translations
src Merge pull request #3156 from pentode/master
tests test
.editorconfig Fix editorconfig syntax
.gitignore ignored public/uploads again
.jsbeautifyrc format/jshint favourites.js
.jshintrc jshint: temporarily setting unused flag to false, low priority right …
.travis.yml install latest mongo in travis, travis only has 2.4.10
CONTRIBUTING.md made the security vulnerability section a bit more obvious
Gruntfile.js grunt: watch for tjs changes as well
LICENSE Resolving issue #2 -- added GPLv3 license file and updated package.json
README.md updated readme a bit
app.js finished up executable rewrite, and prettified reset script output
bcrypt.js shorter bcrypt
loader.js allowing usage of "false" in silent and daemon environment variables
minifier.js don't try to minify non-js files
nodebb finished up executable rewrite, and prettified reset script output
nodebb.bat That's not how you do comments silly
package.json Merge pull request #3156 from pentode/master

README.md

NodeBB

Gitter Build Status Dependency Status Code Climate Documentation Status

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 is compatible down to IE8 and has many modern features out of the box such as social network integration and streaming discussions.

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

Screenshots

         

How can I follow along/contribute?

  • Our feature roadmap is hosted on the project wiki's Version History / Roadmap
  • 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 extention 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 0.10 or greater
  • 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.

Something went wrong with that request. Please try again.