diff --git a/doc/src/scripts/index.rst b/doc/src/scripts/index.rst index 6e6755b643fc..0eea47e1e085 100644 --- a/doc/src/scripts/index.rst +++ b/doc/src/scripts/index.rst @@ -5,7 +5,6 @@ Developing Plugins :maxdepth: 2 overview - structure alert_endpoints alert_definitions checks diff --git a/doc/src/scripts/structure.rst b/doc/src/scripts/structure.rst deleted file mode 100644 index 910417e11ccf..000000000000 --- a/doc/src/scripts/structure.rst +++ /dev/null @@ -1,55 +0,0 @@ -.. _Script Structure: - -Script Structure -================ - -The most complete example of script structure is the following - -.. code:: bash - - example/ - |-- manifest.lua - |-- locales - | `-- en.lua - |-- alert_endpoints - | |-- example.lua - | `-- prefs_entries.lua - |-- alert_definitions - | `-- alert_example.lua - |-- status_definitions - | `-- status_example.lua - |-- checks - | |-- interface - | | `-- example.lua - | |-- network - | | `-- example.lua - | |-- snmp_device - | | `-- example.lua - | `-- system - | `-- example.lua - |-- ts_schemas - | |-- min.lua - | `-- 5mins.lua - `-- web_gui - |-- example_page.lua - `-- menu.lua - -The root directory :code:`example` must have a name which is -representative for the script. Sub-directories contain: - -- :code:`manifest.lua`: file containing a name and a description of the script. See :ref:`Manifest`. -- :code:`locales` (optional): files for the localization of strings used within the script, such as the description of a generated alert. When this directory is omitted, strings found in the script will be taken verbatim. See :ref:`Script Localization`. -- :code:`alert_endpoints` (optional): files to create alert endpoints. An alert endpoint is called by ntopng every time an alert is - generated. Alert endpoints enable an alert to be post-processed or delivered downstream to an external alert collector. This directory can be omitted when the script does not create alert endpoints. See :ref:`Alert Endpoints`. -- :code:`checks`: files with the logic necessary to - perform custom actions. This directory contains additional - sub-directories, namely, :code:`interface`, :code:`network`, - :code:`snmp_device`, and :code:`system`. ntopng guarantees files - found under the :code:`interface` directory are be executed for every - interface; files found under the :code:`network` directory will be executed for every local network; and so on. - Sub-directories can be missing or empty, depending - on whether the scripts wants to perform certain actions or not. See :ref:`Checks`. -- :code:`ts_schemas`: contains timeseries schemas definitions. See :ref:`Timeseries Schemas`. -- :code:`web_gui`: file to create custom ntopng pages and link them in - the main ntopng menu. See :ref:`Custom Pages`. -