Skip to content

Commit

Permalink
Merge pull request #441 from NethServer/master
Browse files Browse the repository at this point in the history
Merge Report and Backup changes into v7
  • Loading branch information
DavidePrincipi committed Jul 29, 2019
2 parents cf39a28 + 3b082e9 commit 30bb34e
Show file tree
Hide file tree
Showing 6 changed files with 163 additions and 26 deletions.
2 changes: 1 addition & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -214,7 +214,7 @@ On Fedora 24 or later use: ::

Then, install all required modules: ::

sudo pip install -f ./administrator-manual/en/nsent/requirements.txt
sudo pip install -r ./administrator-manual/en/nsent/requirements.txt


First clone the repository, enter language directory and type ::
Expand Down
6 changes: 6 additions & 0 deletions administrator-manual/en/.tx/config
Original file line number Diff line number Diff line change
Expand Up @@ -362,3 +362,9 @@ file_filter = locale/<lang>/LC_MESSAGES/virtual_machines.po
source_file = _build/locale/virtual_machines.pot
source_lang = en
type = PO

[docs-v7.report]
file_filter = locale/<lang>/LC_MESSAGES/report.po
source_file = _build/locale/report.pot
source_lang = en
type = PO
51 changes: 40 additions & 11 deletions administrator-manual/en/backup.rst
Original file line number Diff line number Diff line change
Expand Up @@ -461,23 +461,52 @@ Other restored configurations:

Steps to be executed:

1. Install the new machine. If possible, enable a network connection at
boot (refer to :ref:`installation-manual` section) to automatically re-install
the required modules
.. only:: nscom

2. Access the Server Manager and follow the :ref:`first-configuration-wizard-section` procedure
1. Install the new machine (refer to :ref:`installation <installation-manual>` section), access the
Server Manager and follow the :ref:`first configuration wizard <first-configuration-wizard-section>`
procedure to complete the basic server configuration

3. At step :guilabel:`Restore configuration`, upload the configuration archive.
The option :guilabel:`Download modules automatically` should be enabled.
2. Ensure that |product| is able to access the internet and resolve public names correctly

4. If a warning message requires it, reconfigure the network roles assignment.
See :ref:`restore-roles-section` below.
3. Install all the available core updates in the :ref:`Software Center <software-updates-section>`

5. Verify the system is functional
4. Restore the configuration backup using the :guilabel:`Backup (configuration)` panel

6. Restore data backup executing on the console ::
5. If a warning message requires it, reconfigure the network roles assignment.
See :ref:`restore-roles-section` below.

6. Verify the system is functional

7. Restore data backup executing on the console ::

restore-data -b <name>


.. only:: nsent

1. Install the new machine (refer to :ref:`installation <installation-manual>` section), access the
Server Manager and follow the :ref:`first configuration wizard <first-configuration-wizard-section>`
procedure to complete the basic server configuration

2. Ensure that |product| is able to access the internet and resolve public names correctly

3. Activate |product| following the :ref:`registration <registration-section>` procedure

4. Install all the available core updates in the :ref:`Software Center <software-updates-section>`

5. Restore the configuration backup using the :guilabel:`Backup (configuration)` panel which allows
to use cloud backups or local archives

6. If a warning message requires it, reconfigure the network roles assignment.
See :ref:`restore-roles-section` below.

7. Verify the system is functional

8. Restore data backup executing on the console ::

restore-data -b <name>

restore-data -b <name>

Please note that the disaster recovery should be always performed from a local media (eg. NFS or USB) to speed up the process.

Expand Down
1 change: 1 addition & 0 deletions administrator-manual/en/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,7 @@ Modules
chat
team_chat
ups
report
fax_server
firewall
web_proxy
Expand Down
65 changes: 51 additions & 14 deletions administrator-manual/en/locale/it/LC_MESSAGES/report.po
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,17 @@
# This file is distributed under the same license as the NethServer Enterprise package.
# FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
#
# Translators:
# Nicola <nicola.rauso@nethesis.it>, 2019
#
#, fuzzy
msgid ""
msgstr ""
"Project-Id-Version: NethServer Enterprise 7\n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2019-07-26 10:15+0200\n"
"PO-Revision-Date: 2019-07-26 08:16+0000\n"
"Last-Translator: Nicola <nicola.rauso@nethesis.it>, 2019\n"
"Language-Team: Italian (https://www.transifex.com/nethserver/teams/35834/it/)\n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=UTF-8\n"
Expand All @@ -26,137 +30,170 @@ msgstr ""

#: ../../report.rst:5
msgid "Report"
msgstr ""
msgstr "Report"

#: ../../report.rst:7
msgid ""
"This module manages the configuration of `Dante "
"<https://github.com/nethesis/dante/>`_."
msgstr ""
"Questo modulo gestisce la configurazione di `Dante "
"<https://github.com/nethesis/dante/>`_."

#: ../../report.rst:10
msgid ""
"Dante collects data from logs, databases and services, aggregates and "
"displays them on a report structured as a customizable dashboard. The report"
" can be sent via e-mail, with configurable scheduling and recipients."
msgstr ""
"Dante raccoglie dati da registri, database e servizi, li aggrega e li "
"visualizza in un report strutturato come una dashboard personalizzabile. Il "
"report può essere inviato via e-mail, con pianificazione e destinatari "
"configurabili."

#: ../../report.rst:14
msgid "Dashboard"
msgstr ""
msgstr "Dashboard"

#: ../../report.rst:16
msgid ""
"The *Dashboard* page is composed by a set of widgets, each showing a piece "
"of information on the system. The user can customize the layout of the "
"dashboard by adding, removing, resizing and drag & dropping widgets."
msgstr ""
"La pagina *Dashboard* è composta da una serie di widget, ognuno dei quali "
"mostra un'informazione sul sistema. L'utente può personalizzare il layout "
"della dashboard aggiungendo, rimuovendo, ridimensionando e trascinando i "
"widget."

#: ../../report.rst:19
msgid "The types of widgets currently supported are:"
msgstr ""
msgstr "I tipi di widget attualmente supportati sono:"

#: ../../report.rst:21
msgid "**Chart**: pie, bar, line or area charts"
msgstr ""
msgstr "**Grafico**: grafici a torta, a barre, a linee o ad area"

#: ../../report.rst:22
msgid ""
"**Counter**: a card that displays an aggregated numerical value and a trend "
"on a time interval"
msgstr ""
"**Contatore**: una card che mostra un valore numerico aggregato e una "
"tendenza in un intervallo di tempo"

#: ../../report.rst:23
msgid "**Table**: a table with optional row and column headers"
msgstr ""
msgstr "**Tabella**: una tabella con intestazioni di riga e colonna opzionali"

#: ../../report.rst:24
msgid "**Ranking**: a list of the top N items, ordered by their value"
msgstr ""
"**Rancking**: un elenco dei primi N elementi, ordinati in base al loro "
"valore"

#: ../../report.rst:25
msgid "**Label**: a text showing a piece of information"
msgstr ""
msgstr "**Etichetta**: un testo che mostra un'informazione"

#: ../../report.rst:26
msgid ""
"**Title**: a simple text typed by the user to organize the layout of the "
"dashboard"
msgstr ""
"**Titolo**: un semplice testo digitato dall'utente per organizzare il layout"
" della dashboard"

#: ../../report.rst:29
msgid "Settings"
msgstr ""
msgstr "Impostazioni"

#: ../../report.rst:31
msgid "The *Settings* page manages the configuration of the module."
msgstr ""
msgstr "La pagina *Impostazioni* gestisce la configurazione del modulo."

#: ../../report.rst:34
msgid "Host configuration"
msgstr ""
msgstr "Configurazione host"

#: ../../report.rst:36
msgid ""
"**Public host**: this is the hostname where the report is hosted. It must be"
" a name that can be resolved from the internet"
msgstr ""
"**Host pubblico**: questo è il nome dell'host che ospita il report. Deve "
"essere un nome che può essere risolto da Internet"

#: ../../report.rst:37
msgid ""
"**Final url**: this field displays the public URL where the report is hosted"
msgstr ""
"**URL finale**: questo campo visualizza l'URL pubblico in cui è ospitato il "
"report"

#: ../../report.rst:40
msgid "Report configuration"
msgstr ""
msgstr "Configurazione report"

#: ../../report.rst:42
msgid ""
"**Theme**: the themes available for the dashboard are *light* and *dark*"
msgstr ""
msgstr "**Tema**: i temi disponibili per la dashboard sono *chiaro* e *scuro*"

#: ../../report.rst:43
msgid "**Palette**: there are 9 color palettes to choose from"
msgstr ""
msgstr "**Tavolozza**: ci sono 9 tavolozze di colori tra cui scegliere"

#: ../../report.rst:44
msgid ""
"**Interval**: time interval on which the data are aggregated. It can be "
"*Week*, *Month* or *Six-months*"
msgstr ""
"**Intervallo**: intervallo di tempo su cui vengono aggregati i dati. Può "
"essere *Settimana*, *Mese* o *Sei mesi*"

#: ../../report.rst:45
msgid "**Language**: language used to display the report"
msgstr ""
msgstr "**Lingua**: lingua utilizzata per visualizzare il report"

#: ../../report.rst:46
msgid ""
"**Anonymization**: boolean flag that controls the anonymization of sensible "
"data in the report"
msgstr ""
"**Anonimizzazione**: opzione che controlla l'anonimizzazione dei dati "
"sensibili nel report"

#: ../../report.rst:47
msgid "**Max Entries**: maximum number of items to display on ranking widgets"
msgstr ""
"**Numero massimo di voci**: numero massimo di elementi da visualizzare nei "
"widget di tipo ranking"

#: ../../report.rst:48
msgid ""
"**Addresses**: configuration of report e-mail recipients and scheduling of "
"e-mail dispatch"
msgstr ""
"**Indirizzi**: configurazione dei destinatari e-mail e programmazione della "
"spedizione via e-mail del report"

#: ../../report.rst:51
msgid "Test mail"
msgstr ""
msgstr "Test mail"

#: ../../report.rst:53
msgid "**Address**: e-mail recipient of the test e-mail containing the report"
msgstr ""
"**Indirizzo**: e-mail del destinatario dell'e-mail di prova contenente il "
"report"

#: ../../report.rst:54
msgid ""
"**Include configured addresses**: boolean flag to control whether the test "
"e-mail should be sent to the addresses configured in *Report configuration* "
"in addition to *Address*"
msgstr ""
"**Includi indirizzi configurati**: opzione per controllare se l'e-mail di "
"prova deve essere inviata anche agli altri indirizzi configurati in "
"*Configurazione rapporto* oltre che all'*Indirizzo* specificato"
64 changes: 64 additions & 0 deletions administrator-manual/en/report.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
.. _report-section:

======
Report
======

This module manages the configuration of `Dante
<https://github.com/nethesis/dante/>`_.

Dante collects data from logs, databases and services, aggregates and displays them on a report structured as a customizable dashboard.
The report can be sent via e-mail, with configurable scheduling and recipients.

Dashboard
=========

The *Dashboard* page is composed by a set of widgets, each showing a piece of information on the system.
The user can customize the layout of the dashboard by adding, removing, resizing and drag & dropping widgets.

The types of widgets currently supported are:

* **Chart**: pie, bar, line or area charts
* **Counter**: a card that displays an aggregated numerical value and a trend on a time interval
* **Table**: a table with optional row and column headers
* **Ranking**: a list of the top N items, ordered by their value
* **Label**: a text showing a piece of information
* **Title**: a simple text typed by the user to organize the layout of the dashboard

Settings
========

The *Settings* page manages the configuration of the module.

Host configuration
------------------

* **Public host**: this is the hostname where the report is hosted. It must be a name that can be resolved from the internet
* **Final url**: this field displays the public URL where the report is hosted

Report configuration
--------------------

* **Theme**: the themes available for the dashboard are *light* and *dark*
* **Palette**: there are 9 color palettes to choose from
* **Interval**: time interval on which the data are aggregated. It can be *Week*, *Month* or *Six-months*
* **Language**: language used to display the report
* **Anonymization**: boolean flag that controls the anonymization of sensible data in the report
* **Max Entries**: maximum number of items to display on ranking widgets
* **Addresses**: configuration of report e-mail recipients and scheduling of e-mail dispatch

Test mail
---------

* **Address**: e-mail recipient of the test e-mail containing the report
* **Include configured addresses**: boolean flag to control whether the test e-mail should be sent to the addresses configured in *Report configuration* in addition to *Address*










0 comments on commit 30bb34e

Please sign in to comment.