.. image:: https://i.imgur.com/3yj1n6N.png

|
**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 <https://github.com/designcreateplay/NodeBB/>`_. Don't forget to check out the ways that you can help contribute to this project, from translations, pull requests, and telling your friends.

Table of Contents
=================

.. _installing:

Installing NodeBB
-----------------

.. toctree::
   :maxdepth: 2

   installing/os
   installing/cloud


.. _configuring:

Configuring NodeBB
------------------

.. toctree::
    :maxdepth: 2

    configuring/databases
    configuring/proxies

Running NodeBB
------------------

.. toctree::
    :maxdepth: 2

    running/index

Upgrading NodeBB
------------------

.. toctree::
    :maxdepth: 2

    upgrading/index

Administrating NodeBB
---------------------

.. toctree::
    :maxdepth: 2

    admin/outline
    admin/sso
    admin/uploads

Contributing to NodeBB
----------------------

.. toctree::
    :maxdepth: 2

    contributing/style-guide

Plugin System
-------------

.. toctree::
    :maxdepth: 2

    plugins/create
    plugins/hooks

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`