[skip ci] Updated docs

docs/index.rst

@@ -12,10 +12,7 @@ Ansible role that installs the OpenWISP Server Application.
     ./user/system-requirements.rst
     ./user/quickstart.rst
     ./user/certbot-ssl.rst
-    ./user/enabling-monitoring.rst
-    ./user/enabling-firmware-upgrader.rst
-    ./user/enabling-network-topology.rst
-    ./user/enabling-radius.rst
+    ./user/enabling-modules.rst
     ./user/deploying-custom-static-content.rst
     ./user/configuring-cors-headers.rst
     ./user/installing-on-vm.rst

docs/partials/developer-docs.rst

@@ -9,4 +9,4 @@
     to use OpenWISP, please refer to:
 
     - :doc:`General OpenWISP Quickstart </user/quickstart>`
-    - :doc:`Ansible OpenWISP2 User Docs </ansible-openwisp2/index>`
+    - :doc:`Ansible OpenWISP2 User Docs </ansible/index>`

docs/user/enabling-modules.rst

@@ -0,0 +1,162 @@
+Enabling OpenWISP Modules
+=========================
+
+.. contents::
+    :depth: 1
+    :local:
+
+Enabling the Monitoring Module
+------------------------------
+
+The :doc:`Monitoring module </monitoring/index>` is enabled by default, it
+can be disabled by setting ``openwisp2_monitoring`` to ``false``.
+
+Enabling the Firmware Upgrader Module
+-------------------------------------
+
+It is encouraged that you read the :doc:`quick-start guide of
+openwisp-firmware-upgrader </firmware-upgrader/user/quickstart>` before
+going ahead.
+
+To enable the :doc:`Firmware Upgrader </firmware-upgrader/index>` module
+you need to set ``openwisp2_firmware_upgrader`` to ``true`` in your
+``playbook.yml`` file. Here's a short summary of how to do this:
+
+**Step 1**: :ref:`Install ansible <ansible_install>`
+
+**Step 2**: :ref:`Install this role <ansible_install_role>`
+
+**Step 3**: :ref:`Create inventory file <ansible_create_inventory_file>`
+
+**Step 4**: Create a playbook file with following contents:
+
+.. code-block:: yaml
+
+    - hosts: openwisp2
+      become: "{{ become | default('yes') }}"
+      roles:
+        - openwisp.openwisp2
+      vars:
+        openwisp2_firmware_upgrader: true
+
+**Step 5**: :ref:`Run the playbook <ansible_run_playbook>`
+
+When the playbook is done running, if you got no errors you can login at
+https://openwisp2.mydomain.com/admin with the following credentials:
+
+.. code-block:: text
+
+    username: admin
+    password: admin
+
+You can configure :doc:`openwisp-firmware-upgrader specific settings
+</firmware-upgrader/user/settings>` using the
+``openwisp2_extra_django_settings`` or
+``openwisp2_extra_django_settings_instructions``.
+
+E.g:
+
+.. code-block:: yaml
+
+    - hosts: openwisp2
+      become: "{{ become | default('yes') }}"
+      roles:
+        - openwisp.openwisp2
+      vars:
+        openwisp2_firmware_upgrader: true
+        openwisp2_extra_django_settings_instructions:
+          - |
+            OPENWISP_CUSTOM_OPENWRT_IMAGES = (
+                ('my-custom-image-squashfs-sysupgrade.bin', {
+                    'label': 'My Custom Image',
+                    'boards': ('MyCustomImage',)
+                }),
+            )
+
+Refer the :doc:`role-variables` section of the documentation for a
+complete list of available role variables.
+
+Enabling the Network Topology Module
+------------------------------------
+
+To enable the :doc:`Network Topology module </network-topology/index>` you
+need to set ``openwisp2_network_topology`` to ``true`` in your
+``playbook.yml`` file. Here's a short summary of how to do this:
+
+**Step 1**: :ref:`Install ansible <ansible_install>`
+
+**Step 2**: :ref:`Install this role <ansible_install_role>`
+
+**Step 3**: :ref:`Create inventory file <ansible_create_inventory_file>`
+
+**Step 4**: Create a playbook file with following contents:
+
+.. code-block:: yaml
+
+    - hosts: openwisp2
+      become: "{{ become | default('yes') }}"
+      roles:
+        - openwisp.openwisp2
+      vars:
+        openwisp2_network_topology: true
+
+**Step 5**: :ref:`Run the playbook <ansible_run_playbook>`
+
+When the playbook is done running, if you got no errors you can login at
+https://openwisp2.mydomain.com/admin with the following credentials:
+
+.. code-block:: text
+
+    username: admin
+    password: admin
+
+Enabling the RADIUS Module
+--------------------------
+
+To enable the :doc:`RADIUS module </user/radius>` you need to set
+``openwisp2_radius`` to ``true`` in your ``playbook.yml`` file. Here's a
+short summary of how to do this:
+
+**Step 1**: :ref:`Install ansible <ansible_install>`
+
+**Step 2**: :ref:`Install this role <ansible_install_role>`
+
+**Step 3**: :ref:`Create inventory file <ansible_create_inventory_file>`
+
+**Step 4**: Create a playbook file with following contents:
+
+.. code-block:: yaml
+
+    - hosts: openwisp2
+      become: "{{ become | default('yes') }}"
+      roles:
+        - openwisp.openwisp2
+      vars:
+        openwisp2_radius: true
+        openwisp2_freeradius_install: true
+        # set to false when you don't want to register openwisp-radius
+        # API endpoints.
+        openwisp2_radius_urls: true
+
+.. note::
+
+    ``openwisp2_freeradius_install`` option provides a basic configuration
+    of freeradius for OpenIWSP, it sets up the `radius user token
+    mechanism
+    <https://openwisp-radius.readthedocs.io/en/latest/user/api.html#radius-user-token-recommended>`__
+    if you want to use another mechanism or manage your freeradius
+    separately, please disable this option by setting it to ``false``.
+
+**Step 5**: :ref:`Run the playbook <ansible_run_playbook>`
+
+When the playbook is done running, if you got no errors you can login at:
+
+.. code-block::
+
+    https://openwisp2.mydomain.com/admin
+    username: admin
+    password: admin
+
+**Note:** for more information regarding radius configuration options,
+look for the word “radius” in the :doc:`role-variables` section of this
+document.