From 89a630a705066e40eb03e1a76ab1dc08d182a586 Mon Sep 17 00:00:00 2001
From: RefinedSoftwareLLC <mikar_gibbros@yahoo.com>
Date: Thu, 24 Jul 2014 15:35:44 -0600
Subject: [PATCH] Update smartos.rst
Many small updates
---
docs/installing/os/smartos.rst | 55 ++++++++++++++++++----------------
1 file changed, 30 insertions(+), 25 deletions(-)
diff --git a/docs/installing/os/smartos.rst b/docs/installing/os/smartos.rst
index c28f4d8457..6e95e5719a 100644
--- a/docs/installing/os/smartos.rst
+++ b/docs/installing/os/smartos.rst
@@ -6,8 +6,9 @@ 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 (steps to install from Joyent's package repository given below).
+* A version of Node.js at least 0.10 or greater.
+* Redis, version 2.6 or greater (steps to install from Joyent's package repository given below),
+ or MongoDB, version 2.6 or greater (untested).
* nginx, version 1.3.13 or greater (**only if** intending to use nginx to proxy requests to a NodeBB server).
Server Access
@@ -19,9 +20,9 @@ Server Access
3. Create the newest ``smartos nodejs`` image.
- **Note:** The following steps have been tested with image: ``smartos nodejs 13.1.0``
+ **Note:** The following steps have been tested with images: ``smartos nodejs 13.1.0`` ``smartos nodejs 13.2.3``
-4. Wait for your instance to show `Running` then click on its name.
+4. Wait for your instance to show ``Running`` then click on its name.
5. Find your ``Login`` and admin password. If the ``Credentials`` section is missing, refresh the webpage.
@@ -41,7 +42,7 @@ Installation
$ sudo pkgin update
$ sudo pkgin install scmgit nodejs build-essential ImageMagick redis
- If any of these failed:
+ If any of those failed to install then:
.. code:: bash
@@ -49,16 +50,18 @@ Installation
$ sudo pkgin install *available-name*
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.
-
- **Note:** If you ran `redis-server` manually then exit out of it now.
+
+ If you want to use MongoDB, LevelDB, or another database instead of Redis please look at the :doc:`Configuring Databases <../../configuring/databases>` section.
+
+ **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
$ 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
@@ -82,7 +85,7 @@ Installation
$ 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
@@ -92,29 +95,31 @@ Installation
.. code:: bash
- $ cd nodebb/
+ $ cd nodebb
$ npm install
6. Run NodeBB's setup script:
.. 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.
- C. If you used the above steps to setup your redis-server then use the default redis settings.
-
-7. Start NodeBB process:
-
- **Run NodeBB manually:**
+
+ c. ``Please enter a NodeBB secret`` - Do not email this or post publicly.
+
+ d. ``IP or Hostname to bind to`` - Use default unless your server requires otherwise.
+
+ 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
@@ -123,11 +128,11 @@ Installation
8. Visit your app!
**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
----------------
-**Note:** Detailed upgrade instructions are listed in :doc:`Upgrading NodeBB <../../upgrading/index>`.
\ No newline at end of file
+**Note:** Detailed upgrade instructions are listed in :doc:`Upgrading NodeBB <../../upgrading/index>`.