Skip to content

Commit

Permalink
updated faq
Browse files Browse the repository at this point in the history
  • Loading branch information
@julianlam
julianlam committed Oct 18, 2016
1 parent 81fb71c commit 4f76537
Show file tree
Hide file tree
Showing 2 changed files with 201 additions and 43 deletions.
130 changes: 130 additions & 0 deletions help/help.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,130 @@
Need Help?
==========

Frequently Asked Questions
--------------------------

If you experience difficulties setting up a NodeBB instance, perhaps one
of the following may help.

### How do I start/stop/restart NodeBB?

You can call the `./nodebb` executable to start and stop NodeBB:

``` {.sourceCode .bash}
$ ./nodebb
Welcome to NodeBB
Usage: ./nodebb {start|stop|reload|restart|log|setup|reset|upgrade|dev}
start Start the NodeBB server
stop Stops the NodeBB server
reload Restarts NodeBB
restart Restarts NodeBB
log Opens the logging interface (useful for debugging)
setup Runs the NodeBB setup script
reset Disables all plugins, restores the default theme.
activate Activate a plugin on start up.
plugins List all plugins that have been installed.
upgrade Run NodeBB upgrade scripts, ensure packages are up-to-date
dev Start NodeBB in interactive development mode
```

### How do I upgrade my NodeBB?

Please consult [Upgrading NodeBB](../upgrading/index)

### I upgraded NodeBB and now X isn't working properly!

Please consult [Upgrading NodeBB](../upgrading/index)

### I installed an incompatible plugin, and now my forum won't start!

If you know which plugin caused problems, disable it by running:
`./nodebb reset -r nodebb-plugin-pluginName`

Otherwise, disable all plugins by running: `./nodebb reset -p`

### Is it possible to install NodeBB via FTP?

It is possible to transfer the files to your remote server using FTP,
but you do require shell access to the server in order to actually
"start" NodeBB. Here is [a handy guide for installing NodeBB on
DigitalOcean](http://burnaftercompiling.com/nodebb/setting-up-a-nodebb-forum-for-dummies/)

### I'm getting an "npm ERR!" error

For the most part, errors involving `npm` are due to Node.js being
outdated. If you see an error similar to this one while running
`npm install`:

``` {.sourceCode .bash}
npm ERR! Unsupported
npm ERR! Not compatible with your version of node/npm: connect@2.7.11
```

You'll need to update your Node.js version to 4 or higher.

To do this on Ubuntu:

``` {.sourceCode .bash}
# Using Ubuntu
curl -sL https://deb.nodesource.com/setup_4.x | sudo -E bash -
sudo apt-get install -y nodejs
# Using Debian, as root
curl -sL https://deb.nodesource.com/setup_4.x | bash -
apt-get install -y nodejs
```

If successful, running the following command should show a version
higher than 0.8

``` {.sourceCode .bash}
# apt-cache policy nodejs
```

### URLs on my NodeBB (or emails) still have the port number in them!

If you are using nginx <../configuring/proxies/nginx> or
Apache <../configuring/proxies/apache> as a reverse proxy, you
don't need the port to be shown. Simply run ./nodebb setup and specify
the base URL without a port number.

Alternatively, edit the `config.json` file using your favourite text
editor and change `use_port` to `false`.

### The "Recently Logged In IPs" section only shows 127.0.0.1

NodeBBs running behind a proxy may have difficulties determining the
original IP address that requests come from. It is important that the
proxy server provides the referral IP header.

In nginx, ensure that the following line is present in your `server`
block:

``` {.sourceCode .nginx}
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
```

In addition, ensure that the `use_port` option is set to `false` in your
NodeBB's `config.json`

Submit Bugs on our Issue Tracker
--------------------------------

Before reporting bugs, please ensure that the issue has not already been
filed on our
[tracker](https://github.com/NodeBB/NodeBB/issues?state=closed), or has
already been resolved on our [support
forum](http://community.nodebb.org/category/6/bug-reports). If it has
not been filed, feel free to create an account on GitHub and [create a
new issue](https://github.com/NodeBB/NodeBB/issues).

Ask the NodeBB Community
------------------------

Having trouble installing NodeBB? Or did something break? Don't hesitate
to [join our forum](community.nodebb.org/register) and ask for help.
Hopefully one day you'll be able to help others too :)
114 changes: 71 additions & 43 deletions help/help.rst
View file
Original file line number Diff line number Diff line change
@@ -1,110 +1,138 @@
Need Help?
==========


Frequently Asked Questions
--------------------------

If you experience difficulties setting up a NodeBB instance, perhaps one of the following may help.
If you experience difficulties setting up a NodeBB instance, perhaps one
of the following may help.

How do I start/stop/restart NodeBB?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

You can call the ``./nodebb`` executable to start and stop NodeBB:

.. code:: bash
$ ./nodebb
Welcome to NodeBB
Usage: ./nodebb {start|stop|reload|restart|log|setup|reset|upgrade|dev|watch}
start Start the NodeBB server
stop Stops the NodeBB server
reload Restarts NodeBB
restart Restarts NodeBB
log Opens the logging interface (useful for debugging)
setup Runs the NodeBB setup script
reset Disables all plugins, restores the default theme.
upgrade Run NodeBB upgrade scripts, ensure packages are up-to-date
dev Start NodeBB in interactive development mode
watch Start NodeBB in development mode and watch for changes
Welcome to NodeBB
Usage: ./nodebb {start|stop|reload|restart|log|setup|reset|upgrade|dev}
start Start the NodeBB server
stop Stops the NodeBB server
reload Restarts NodeBB
restart Restarts NodeBB
log Opens the logging interface (useful for debugging)
setup Runs the NodeBB setup script
reset Disables all plugins, restores the default theme.
activate Activate a plugin on start up.
plugins List all plugins that have been installed.
upgrade Run NodeBB upgrade scripts, ensure packages are up-to-date
dev Start NodeBB in interactive development mode
How do I upgrade my NodeBB?
^^^^^^^^^^^^^^^^^^^^^^^^^^^
~~~~~~~~~~~~~~~~~~~~~~~~~~~

Please consult :doc:`Upgrading NodeBB <../upgrading/index>`
Please consult `Upgrading NodeBB <../upgrading/index>`__

I upgraded NodeBB and now X isn't working properly!
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Please consult :doc:`Upgrading NodeBB <../upgrading/index>`
Please consult `Upgrading NodeBB <../upgrading/index>`__

I installed an incompatible plugin, and now my forum won't start!
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

If you know which plugin caused problems, disable it by running: ``./nodebb reset plugin="nodebb-plugin-pluginName"``
If you know which plugin caused problems, disable it by running:
``./nodebb reset -r nodebb-plugin-pluginName``

Otherwise, disable all plugins by running: ``./nodebb reset plugins``
Otherwise, disable all plugins by running: ``./nodebb reset -p``

Is it possible to install NodeBB via FTP?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

It is possible to transfer the files to your remote server using FTP, but you do require shell access to the server in order to actually "start" NodeBB. Here is `a handy guide for installing NodeBB on DigitalOcean <http://burnaftercompiling.com/nodebb/setting-up-a-nodebb-forum-for-dummies/>`_
It is possible to transfer the files to your remote server using FTP,
but you do require shell access to the server in order to actually
"start" NodeBB. Here is `a handy guide for installing NodeBB on
DigitalOcean <http://burnaftercompiling.com/nodebb/setting-up-a-nodebb-forum-for-dummies/>`__

I'm getting an "npm ERR!" error
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

For the most part, errors involving ``npm`` are due to Node.js being outdated. If you see an error similar to this one while running ``npm install``:
For the most part, errors involving ``npm`` are due to Node.js being
outdated. If you see an error similar to this one while running
``npm install``:

.. code:: bash
npm ERR! Unsupported
npm ERR! Not compatible with your version of node/npm: connect@2.7.11
You'll need to update your Node.js version to 0.8 or higher.
You'll need to update your Node.js version to 4 or higher.

To do this on Ubuntu:

.. code:: bash
# add-apt-repository ppa:chris-lea/node.js
# apt-get update && apt-get dist-upgrade -y
# Using Ubuntu
curl -sL https://deb.nodesource.com/setup_4.x | sudo -E bash -
sudo apt-get install -y nodejs
If successful, running the following command should show a version higher than 0.8
# Using Debian, as root
curl -sL https://deb.nodesource.com/setup_4.x | bash -
apt-get install -y nodejs
If successful, running the following command should show a version
higher than 0.8

.. code:: bash
# apt-cache policy nodejs
URLs on my NodeBB (or emails) still have the port number in them!
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

If you are using :doc:`nginx <../configuring/proxies/nginx>` or :doc:`Apache <../configuring/proxies/apache>` as a reverse proxy, you don't need the port to be shown. Simply run `./nodebb setup` and specify the base URL without a port number.
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Alternatively, edit the ``config.json`` file using your favourite text editor and change ``use_port`` to ``false``.
If you are using nginx <../configuring/proxies/nginx> or Apache
<../configuring/proxies/apache> as a reverse proxy, you don't need the
port to be shown. Simply run ./nodebb setup and specify the base URL
without a port number.

Alternatively, edit the ``config.json`` file using your favourite text
editor and change ``use_port`` to ``false``.

The "Recently Logged In IPs" section only shows 127.0.0.1
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

NodeBBs running behind a proxy may have difficulties determining the original IP address that requests come from. It is important that the proxy server provides the referral IP header.
NodeBBs running behind a proxy may have difficulties determining the
original IP address that requests come from. It is important that the
proxy server provides the referral IP header.

In nginx, ensure that the following line is present in your ``server`` block:
In nginx, ensure that the following line is present in your ``server``
block:

.. code:: nginx
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
In addition, ensure that the ``use_port`` option is set to ``false`` in your NodeBB's ``config.json``

In addition, ensure that the ``use_port`` option is set to ``false`` in
your NodeBB's ``config.json``

Submit Bugs on our Issue Tracker
--------------------------------

Before reporting bugs, please ensure that the issue has not already been filed on our `tracker <https://github.com/NodeBB/NodeBB/issues?state=closed>`_, or has already been resolved on our `support forum <http://community.nodebb.org/category/6/bug-reports>`_. If it has not been filed, feel free to create an account on GitHub and `create a new issue <https://github.com/NodeBB/NodeBB/issues>`_.

Before reporting bugs, please ensure that the issue has not already been
filed on our
`tracker <https://github.com/NodeBB/NodeBB/issues?state=closed>`__, or
has already been resolved on our `support
forum <http://community.nodebb.org/category/6/bug-reports>`__. If it has
not been filed, feel free to create an account on GitHub and `create a
new issue <https://github.com/NodeBB/NodeBB/issues>`__.

Ask the NodeBB Community
------------------------

Having trouble installing NodeBB? Or did something break? Don't hesitate to `join our forum <community.nodebb.org/register>`_ and ask for help. Hopefully one day you'll be able to help others too :)
Having trouble installing NodeBB? Or did something break? Don't hesitate
to `join our forum <community.nodebb.org/register>`__ and ask for help.
Hopefully one day you'll be able to help others too :)

0 comments on commit 4f76537

Please sign in to comment.