hyperzlib
/
nodebb
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
isekai-main
v1.18.x
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '666cb4c927'
${ noResults }
nodebb/README.md

4.5 KiB
Raw Blame History

NodeBB

NodeBB is a robust Node.js driven forum built on a Redis database. It is powered by web sockets, and is compatible down to IE8.

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.
  • 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.

Screenshots

       

Credit: Convoe, Kano, Manchester United Forum.

Requirements

NodeBB requires the following software to be installed:

  • A version of Node.js at least 0.8 or greater
  • Redis, version 2.6 or greater or MongoDB, version 2.4 or greater
  • nginx, version 1.3.13 or greater (only if intending to use nginx to proxy requests to a NodeBB)

Installation

First, we install our base software stack:

# apt-get install git nodejs redis-server build-essential imagemagick

If you want to use MongoDB instead of Redis install it from http://www.mongodb.org/downloads and remove 'redis-server' from the above command. MongoDB-Setup

If your package manager only installed a version of Node.js that is less than 0.8 (e.g. Ubuntu 12.10, 13.04):

# add-apt-repository ppa:chris-lea/node.js
# apt-get update && apt-get dist-upgrade

Next, clone this repository:

$ cd /path/to/nodebb/install/location
$ git clone git://github.com/designcreateplay/NodeBB.git nodebb

Obtain all of the dependencies required by NodeBB:

$ cd nodebb
$ npm install

Initiate the setup script by running the app with the --setup flag:

$ node app --setup

The default settings are for a local server running on the default port, with a redis store on the same machine/port.

Lastly, we run the forum.

$ node app

NodeBB can also be started with helper programs, such as supervisor and forever. Take a look at the options here.

(Optional) Some server configurations may install the node binary as nodejs instead of node. You can re-map it (so as to not break compatibility with node-supervisor) by running the following command:

# update-alternatives --install /usr/bin/node node /usr/bin/nodejs 10

Upgrading NodeBB

Detailed upgrade instructions are listed in Upgrading NodeBB