55b0e902fb
Squashed commit of the following:
commit c6d09396208a10c244d7b3d22ffd2d7dd1274d3a
Author: Julian Lam <julian@nodebb.org>
Date: Fri Jul 24 13:41:32 2020 -0400
fix: more tests
commit 32f9af2a87a81fa62ecca01e71d6f0d5b9d37ba1
Merge: e50907535
|
5 years ago | |
|---|---|---|
| .github | ||
| .tx | 5 years ago | |
| build | ||
| install | 5 years ago | |
| logs | ||
| public | 5 years ago | |
| src | 5 years ago | |
| test | 5 years ago | |
| .codeclimate.yml | ||
| .editorconfig | ||
| .eslintignore | ||
| .eslintrc | 5 years ago | |
| .gitattributes | ||
| .gitignore | 5 years ago | |
| .jsbeautifyrc | ||
| .jshintrc | ||
| .mocharc.yml | 5 years ago | |
| .travis.yml | 5 years ago | |
| CHANGELOG.md | 5 years ago | |
| Dockerfile | ||
| Gruntfile.js | 5 years ago | |
| LICENSE | ||
| README.md | 5 years ago | |
| app.js | 5 years ago | |
| commitlint.config.js | ||
| docker-compose.yml | ||
| loader.js | 5 years ago | |
| nodebb | ||
| nodebb.bat | ||
| renovate.json | ||
| require-main.js | ||
README.md
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.
- Demo & Meta Discussion
- Documentation & Installation Instructions
- Help translate NodeBB
- NodeBB Blog
- Premium Hosting for NodeBB
- Follow us on Twitter
- Like us on Facebook
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 10 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:
- 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_addressto127.0.0.1so as to restrict access to the local machine only - Use
requirepassto secure Redis behind a password (preferably a long one) - Familiarise yourself with Redis Security
- Set
- Use
iptablesto secure your server from unintended open ports. In Ubuntu,ufwprovides a friendlier interface to working withiptables.- 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.