Doc update web UI, backup restore, settings

This commit is contained in:
Simone Mainardi 2021-07-30 11:34:43 +02:00
parent a0741179e3
commit c5bd0570b3
7 changed files with 19 additions and 80 deletions

Binary file not shown.

After

Width:  |  Height:  |  Size: 70 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 154 KiB

After

Width:  |  Height:  |  Size: 71 KiB

Before After
Before After

Binary file not shown.

Before

Width:  |  Height:  |  Size: 38 KiB

After

Width:  |  Height:  |  Size: 31 KiB

Before After
Before After

View file

@ -19,42 +19,23 @@ Configuring a check means:
- Enabling/disabling it.
- Setting its configuration values.
`Configurations` are used to accomplish this.
Editing Checks
~~~~~~~~~~~~~~
Configurations
--------------
Checks are configured by means of `Configurations`. A `Default` configuration is always present. The `Default` configuration is used to configure:
- SNMP devices checks.
- Global system-wide checks.
The default configuration is also applied to:
- Any host of every interface.
- Any flow of every interface.
- Any interface.
- Any local network defined.
Additional configurations can be created to limit the scope of their application. This means any additional configurations can be applied to:
- Any subset of hosts of every interface.
- Any flow of a subset of the active interfaces.
- A subset of the active interfaces.
- A subset of the defined local networks.
The scope of application is shown in column `Applied To`. The Default configuration is `Applied to` any network element which is not included in any other configuration.
Editing Configurations
~~~~~~~~~~~~~~~~~~~~~~
Checks configurations can be edited for any of the configurable network elements. The edit page shows three tabs, namely `All`, `Enabled`, and `Disabled` to give immediate access to the whole list of checks, or to limit the view to only those that are enabled or disabled.
Checks can be edited for any of the configurable network elements. The edit page shows three tabs, namely `All`, `Enabled`, and `Disabled` to give immediate access to the whole list of checks, or to limit the view to only those that are enabled or disabled.
A check can be enabled or disabled by clicking the corresponding button under the `Actions` column. Certain checks can also have their values configured. In this case, an extra button `Edit` becomes available under the `Actions` column.
Resetting, Importing and Exporting Configurations
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Resetting, Importing and Exporting Configured Checks
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
All existing configurations can be imported and exported in bulk, to ease backup, restore, and replication across multiple machines. Buttons to perform this task are available below the configuration list. Button `Export Configuration` allows to download a JSON file, whereas button `Import Configuration` accepts a previously downloaded JSON file to load the configurations. `Reset Configuration` cleans up any existing configuration on the current system.
All existing check configurations can be imported and exported in bulk, to ease backup, restore, and replication across multiple machines. To perform these actions, visit the System Interface -> Settings -> Manage Configurations and select Checks
.. figure:: ../img/web_gui_checks_import_export.png
:align: center
:alt: Checks Import, Export and Reset
Checks Import, Export and Reset

View file

@ -14,20 +14,7 @@ Other than the actual timeseries data, the chart will also show:
- A comparison series with the past. In the picture above, `30m ago` will show the
interface traffic 30 minutes ago.
- A trend line, which indicates the trend of the total traffic in the specified period.
This is based on the https://github.com/stanford-futuredata/ASAP algorithm.
- A SMA line, for the `Simple Moving Average`_ of the traffic. This performs an average
on the traffic trend by smoothing it.
- An EMA line, for the `Exponential Moving Average`_ of the traffic. This reacts to
trends changes more quickly then the SMA.
- An RSI line, for the `Relative Strength Index`_ on the difference between now and the
past. Usually an RSI value above 70 indicates a major increase of the traffic as compared to the
previous period, whereas an RSI value below 30 indicates a major decrease.
- The average line, a straight line outlining the average value for the timeseries.
- 95th percentile, a straight line outlining the 95th `percentile`_ value of the traffic.

View file

@ -1,3 +1,5 @@
.. _ConfigurationImportExport:
Configuration Import/Export
===========================

View file

@ -100,39 +100,8 @@ it is possible to:
- Delete the inactive interfaces data. This can be very useful to free some disk space for old
interfaces.
Backup Configuration
--------------------
Backup and Restore
------------------
The Backup Configuration entry downloads a copy of the ntopng
configuration, as a compressed tarball (.tar.gz). The following files
and directories are included in the backup:
To backup and restore see ConfigurationImportExport_.
- Configuration file (unless command line is used for providing the options)
- /etc/ntopng folder
- Runtime configuration (runtimeprefs.json)
- License file
Please note that on Windows systems the runtime configuration file only is provided.
Restore Configuration
---------------------
ntopng configuration can be restored by placing the compressed tarball
(downloaded via Backup Configuration) into the ntopng data directory
and restarting the service. The tarball must be named conf.tar.gz.
For example, assuming the default /var/lib/ntopng data directory has not been changed, one can
restore a previously backed-up configuration by placing the compressed
tarball in /var/lib/ntopng/conf.tar.gz and then issuing a
:code:`systemctl restart ntopng`.
.. note::
After the restore, the compressed archive into the data directory
is automatically deleted.
.. note::
Restore is only supported for packaged ntopng installations on
systems that use :code:`systemd`. Geeks and those who are building
ntopng from source should have a look at script :code:`httpdocs/misc/ntopng-utils-manage-config`.