2. **If needed** setup a redis-server with default settings as a service (automatically starts and restarts):
2. **If needed** setup a redis-server with default settings as a service (automatically starts and restarts):
**Note:** These steps quickly setup a redis server but does not fine-tuned it for production.
If you want to use MongoDB, LevelDB, or another database instead of Redis please look at the :doc:`Configuring Databases <../../configuring/databases>` section.
**Note:** If you ran `redis-server` manually then exit out of it now.
**Note:** These steps quickly setup a redis server but do not fine-tuned it for production.
**Note:** If you manually ran ``redis-server`` then exit out of it now.
..code:: bash
..code:: bash
$ svcadm enable redis
$ svcadm enable redis
$ svcs
$ svcs svc:/pkgsrc/redis:default
*-* If `svcs` shows "/pkgsrc/redis:default" in maintenance mode then:
**Note:** If the STATE is maintenance then:
..code:: bash
..code:: bash
@ -82,7 +85,7 @@ Installation
$ cd /parent/directory/of/nodebb/
$ cd /parent/directory/of/nodebb/
4. Clone NodeBB's repository:
4. Clone NodeBB's repository (you may replace the ending nodebb with a different folder name):
..code:: bash
..code:: bash
@ -92,29 +95,31 @@ Installation
..code:: bash
..code:: bash
$ cd nodebb/
$ cd nodebb
$ npm install
$ npm install
6. Run NodeBB's setup script:
6. Run NodeBB's setup script:
..code:: bash
..code:: bash
$ node app --setup
$ ./nodebb setup
A. `URL of this installation` is either your public ip address from your ssh `Login` or your domain name pointing to that ip address.
a. ``URL used to access this NodeBB`` is either your public ip address from your ssh `Login` or your domain name pointing to that ip address.
**Example:**`http://0.0.0.0` or `http://example.org`
**Example:**``http://0.0.0.0`` or ``http://example.org``
B. `Port number of your NodeBB` is the port needed to access your site:
b. ``Port number of your NodeBB`` is the port needed to access your site:
**Note:** If you do not proxy your port with something like nginx then port 80 is recommended for production.
**Note:** If you do not proxy your port with something like nginx then port 80 is recommended for production.
C. If you used the above steps to setup your redis-server then use the default redis settings.
c. ``Please enter a NodeBB secret`` - Do not email this or post publicly.
7. Start NodeBB process:
d. ``IP or Hostname to bind to`` - Use default unless your server requires otherwise.
**Run NodeBB manually:**
e. If you used the above steps to setup your redis-server then use the default redis settings.
**Note:** This should not be used for production.
7. Start NodeBB process manually:
**Note:** This should not be used for production but instead create a deamon manually, use Forever, or use Supervisor :doc:`Take a look at the options here <../../running/index>`.
..code:: bash
..code:: bash
@ -123,11 +128,11 @@ Installation
8. Visit your app!
8. Visit your app!
**Example:** With a port of 4567: ``http://0.0.0.0:4567`` or ``http://example.org:4567``
**Example:** With a port of 4567: ``http://0.0.0.0:4567`` or ``http://example.org:4567``
**Note:** With port 80 the `:80` does not need to be entered.
**Note:** With port 80 the ``:80`` does not need to be entered.
**Note:** If these instructions are unclear or if you run into trouble, please let us know by `filing an issue <https://github.com/NodeBB/NodeBB/issues>`_.
**Note:** If these instructions are unclear or if you run into trouble, please let us know by `filing an issue <https://github.com/NodeBB/NodeBB/issues>`.
Upgrading NodeBB
Upgrading NodeBB
----------------
----------------
**Note:** Detailed upgrade instructions are listed in :doc:`Upgrading NodeBB <../../upgrading/index>`.
**Note:** Detailed upgrade instructions are listed in :doc:`Upgrading NodeBB <../../upgrading/index>`.