index.rst

NodeBB is a next-generation discussion platform that utilizes web sockets for instant interactions and real-time notifications. NodeBB forums have many modern features out of the box such as social network integration and streaming discussions.

NodeBB is an open source project which can be forked on GitHub. If there are any discrepancies in the documentation please feel free to submit a pull request (via the "Edit on GitHub" button on the top right) or raise an issue on our issue tracker.

The documentation portal has been migrated to https://docs.nodebb.org. This is kept as an archive

Table of Contents

Installing NodeBB

.. toctree::
   :maxdepth: 2

   installing/os
   installing/cloud

Configuring NodeBB

.. toctree::
    :maxdepth: 2

    configuring/config
    configuring/databases
    configuring/proxies

Running NodeBB

.. toctree::
    :maxdepth: 2

    running/index

Upgrading NodeBB

.. toctree::
    :maxdepth: 2

    upgrading/index

Administrating NodeBB

.. toctree::
    :maxdepth: 2

    admin/index
    admin/uploads

Scaling NodeBB

.. toctree::
    :maxdepth: 2

    scaling/index

Contributing to NodeBB

.. toctree::
    :maxdepth: 2

    contributing/style-guide
    modules/index

Plugin System

.. toctree::
    :maxdepth: 2

    plugins/create
    plugins/hooks
    plugins/settings
    plugins/i18n

Widgets System

.. toctree::
    :maxdepth: 2

    widgets/create

Theming Engine

.. toctree::
    :maxdepth: 2

    themes/create
    themes/templates

Developer's Resources

.. toctree::
    :maxdepth: 2

    resources

Helping out the NodeBB Project

.. toctree::
    :maxdepth: 2

    helping/index

Troubleshooting / Help

.. toctree::
    :maxdepth: 2

    help/help

Indices and tables

• :ref:`genindex`
• :ref:`modindex`
• :ref:`search`