From 0e730738e0296539fa1fee5ed6291ab64cbd5bb0 Mon Sep 17 00:00:00 2001 From: Gagan Deep Date: Fri, 14 Jun 2024 22:47:30 +0530 Subject: [PATCH] [skip ci] Updated docs --- docs/index.rst | 5 +- docs/partials/developer-docs.rst | 2 +- docs/user/enabling-firmware-upgrader.rst | 64 --------- docs/user/enabling-modules.rst | 162 +++++++++++++++++++++++ docs/user/enabling-monitoring.rst | 5 - docs/user/enabling-network-topology.rst | 33 ----- docs/user/enabling-radius.rst | 50 ------- 7 files changed, 164 insertions(+), 157 deletions(-) delete mode 100644 docs/user/enabling-firmware-upgrader.rst create mode 100644 docs/user/enabling-modules.rst delete mode 100644 docs/user/enabling-monitoring.rst delete mode 100644 docs/user/enabling-network-topology.rst delete mode 100644 docs/user/enabling-radius.rst diff --git a/docs/index.rst b/docs/index.rst index c6b8bccd..e208e702 100644 --- a/docs/index.rst +++ b/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 diff --git a/docs/partials/developer-docs.rst b/docs/partials/developer-docs.rst index 7d4684e7..76dede26 100644 --- a/docs/partials/developer-docs.rst +++ b/docs/partials/developer-docs.rst @@ -9,4 +9,4 @@ to use OpenWISP, please refer to: - :doc:`General OpenWISP Quickstart ` - - :doc:`Ansible OpenWISP2 User Docs ` + - :doc:`Ansible OpenWISP2 User Docs ` diff --git a/docs/user/enabling-firmware-upgrader.rst b/docs/user/enabling-firmware-upgrader.rst deleted file mode 100644 index ca77998b..00000000 --- a/docs/user/enabling-firmware-upgrader.rst +++ /dev/null @@ -1,64 +0,0 @@ -Enabling the Firmware Upgrader Module -===================================== - -**Note**: It is encouraged that you read the :doc:`quick-start guide of -openwisp-firmware-upgrader ` before -going ahead. - -To enable the :doc:`Firmware Upgrader ` 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 ` - -**Step 2**: :ref:`Install this role ` - -**Step 3**: :ref:`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 ` - -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 -` 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. diff --git a/docs/user/enabling-modules.rst b/docs/user/enabling-modules.rst new file mode 100644 index 00000000..4705358a --- /dev/null +++ b/docs/user/enabling-modules.rst @@ -0,0 +1,162 @@ +Enabling OpenWISP Modules +========================= + +.. contents:: + :depth: 1 + :local: + +Enabling the Monitoring Module +------------------------------ + +The :doc:`Monitoring module ` 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 ` before +going ahead. + +To enable the :doc:`Firmware Upgrader ` 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 ` + +**Step 2**: :ref:`Install this role ` + +**Step 3**: :ref:`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 ` + +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 +` 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 ` 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 ` + +**Step 2**: :ref:`Install this role ` + +**Step 3**: :ref:`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 ` + +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 ` 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 ` + +**Step 2**: :ref:`Install this role ` + +**Step 3**: :ref:`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 + `__ + 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 ` + +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. diff --git a/docs/user/enabling-monitoring.rst b/docs/user/enabling-monitoring.rst deleted file mode 100644 index 99b2184b..00000000 --- a/docs/user/enabling-monitoring.rst +++ /dev/null @@ -1,5 +0,0 @@ -Enabling the Monitoring Module -============================== - -The :doc:`Monitoring module ` is enabled by default, it -can be disabled by setting ``openwisp2_monitoring`` to ``false``. diff --git a/docs/user/enabling-network-topology.rst b/docs/user/enabling-network-topology.rst deleted file mode 100644 index eb070437..00000000 --- a/docs/user/enabling-network-topology.rst +++ /dev/null @@ -1,33 +0,0 @@ -Enabling the Network Topology Module -==================================== - -To enable the :doc:`Network Topology module ` 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 ` - -**Step 2**: :ref:`Install this role ` - -**Step 3**: :ref:`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 ` - -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 diff --git a/docs/user/enabling-radius.rst b/docs/user/enabling-radius.rst deleted file mode 100644 index 9de7201d..00000000 --- a/docs/user/enabling-radius.rst +++ /dev/null @@ -1,50 +0,0 @@ -Enabling the RADIUS Module -========================== - -To enable the :doc:`RADIUS module ` 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 ` - -**Step 2**: :ref:`Install this role ` - -**Step 3**: :ref:`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 - `__ - 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 ` - -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.