NodeBB

Node.js based forum software built for the modern web

README

NodeBB

Workflow Coverage Status Code Climate undefined

[NodeBB Forum Software](https://nodebb.org) is powered by Node.js and supports either Redis, MongoDB, or a PostgreSQL database. It utilizes web sockets for instant interactions and real-time notifications. NodeBB takes the best of the modern web: real-time streaming discussions, mobile responsiveness, and rich RESTful read/write APIs, while staying true to the original bulletin board/forum format → categorical hierarchies, local user accounts, and asynchronous messaging.

NodeBB by itself contains a "common core" of basic functionality, while additional functionality and integrations are 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:
undefined undefined undefined undefined undefined undefined undefined undefined

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



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 12 or greater (installation/upgrade instructions)
MongoDB, version 3.6 or greater or Redis, version 2.8.9 or greater
If you are using clustering you need Redis installed and configured.
nginx, version 1.3.13 or greater (only if intending to use nginx to proxy requests to a NodeBB)

Installation



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.

More Information/Links


Unofficial IRC community – channel #nodebb on Libera.chat