1c2518fe22
Squashed commit of the following: commit 9d4937fff6f6a1b4327fed0ada32153bd7e07efd Author: Julian Lam <julian@designcreateplay.com> Date: Mon Jan 18 13:21:52 2016 -0500 Revert "added some debug code" This reverts commit 2dd8535c7bd8f59b8ed59c8b98b5484a79fa0500. commit 2dd8535c7bd8f59b8ed59c8b98b5484a79fa0500 Author: Julian Lam <julian@designcreateplay.com> Date: Mon Jan 18 12:04:02 2016 -0500 added some debug code commit af8ca8241e66fd538089517e7722c644668667f2 Author: Julian Lam <julian@designcreateplay.com> Date: Mon Jan 18 11:50:41 2016 -0500 using sendmail instead of direct transport |
9 years ago | |
---|---|---|
.tx | 9 years ago | |
install | 9 years ago | |
logs | 11 years ago | |
public | 9 years ago | |
src | 9 years ago | |
tests | 9 years ago | |
.codeclimate.yml | 9 years ago | |
.editorconfig | 10 years ago | |
.gitattributes | 10 years ago | |
.gitignore | 9 years ago | |
.jsbeautifyrc | 12 years ago | |
.jshintrc | 9 years ago | |
.travis.yml | 9 years ago | |
CONTRIBUTING.md | 9 years ago | |
Dockerfile | 9 years ago | |
Gruntfile.js | 10 years ago | |
LICENSE | 12 years ago | |
README.md | 10 years ago | |
app.js | 9 years ago | |
bcrypt.js | 10 years ago | |
loader.js | 9 years ago | |
minifier.js | 9 years ago | |
nodebb | 9 years ago | |
nodebb.bat | 10 years ago | |
package.json | 9 years ago |
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.
- Get NodeBB
- Demo & Meta Discussion
- Documentation & Installation Instructions
- Help translate NodeBB
- NodeBB Blog
- Join us on IRC - #nodebb on Freenode
- Follow us on Twitter
- Like us on Facebook
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:
- 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
to127.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
- Set
- Use
iptables
to secure your server from unintended open ports. In Ubuntu,ufw
provides 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.