mirror of
https://github.com/YunoHost-Apps/monitorix_ynh.git
synced 2024-09-03 19:46:06 +02:00
Auto-update READMEs
This commit is contained in:
yunohost-bot
autoreadme_webhook
parent
9e9d8e3ae2
commit
5c21a00790
5 changed files with 639 additions and 29 deletions
6
ALL_README.md
Normal file
6
ALL_README.md
Normal file
|
|
@ -0,0 +1,6 @@
|
||||||
|
# All available README files by language
|
||||||
|
|
||||||
|
- [Read the README in English](README.md)
|
||||||
|
- [Irakurri README euskaraz](README_eu.md)
|
||||||
|
- [Lire le README en français](README_fr.md)
|
||||||
|
- [Le o README en galego](README_gl.md)
|
||||||
26
README.md
26
README.md
|
|
@ -1,5 +1,5 @@
|
||||||
<!--
|
<!--
|
||||||
N.B.: This README was automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator
|
N.B.: This README was automatically generated by <https://github.com/YunoHost/apps/tree/master/tools/readme_generator>
|
||||||
It shall NOT be edited by hand.
|
It shall NOT be edited by hand.
|
||||||
-->
|
-->
|
||||||
|
|
||||||
|
|
@ -9,10 +9,10 @@ It shall NOT be edited by hand.
|
||||||
|
|
||||||
[](https://install-app.yunohost.org/?app=monitorix)
|
[](https://install-app.yunohost.org/?app=monitorix)
|
||||||
|
|
||||||
*[Lire ce readme en français.](./README_fr.md)*
|
*[Read this README in other languages.](./ALL_README.md)*
|
||||||
|
|
||||||
> *This package allows you to install Monitorix quickly and simply on a YunoHost server.
|
> *This package allows you to install Monitorix quickly and simply on a YunoHost server.*
|
||||||
If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.*
|
> *If you don't have YunoHost, please consult [the guide](https://yunohost.org/install) to learn how to install it.*
|
||||||
|
|
||||||
## Overview
|
## Overview
|
||||||
|
|
||||||
|
|
@ -21,7 +21,7 @@ Monitorix is a free, open source, lightweight system monitoring tool designed to
|
||||||
|
|
||||||
**Shipped version:** 3.15.0~ynh3
|
**Shipped version:** 3.15.0~ynh3
|
||||||
|
|
||||||
**Demo:** https://www.fibranet.cat/monitorix/
|
**Demo:** <https://www.fibranet.cat/monitorix/>
|
||||||
|
|
||||||
## Screenshots
|
## Screenshots
|
||||||
|
|
||||||
|
|
@ -281,19 +281,19 @@ In this config we have :
|
||||||
|
|
||||||
## Documentation and resources
|
## Documentation and resources
|
||||||
|
|
||||||
* Official app website: <http://monitorix.org>
|
- Official app website: <http://monitorix.org>
|
||||||
* Official admin documentation: <https://www.monitorix.org/documentation.html>
|
- Official admin documentation: <https://www.monitorix.org/documentation.html>
|
||||||
* Upstream app code repository: <https://github.com/mikaku/Monitorix>
|
- Upstream app code repository: <https://github.com/mikaku/Monitorix>
|
||||||
* YunoHost Store: <https://apps.yunohost.org/app/monitorix>
|
- YunoHost Store: <https://apps.yunohost.org/app/monitorix>
|
||||||
* Report a bug: <https://github.com/YunoHost-Apps/monitorix_ynh/issues>
|
- Report a bug: <https://github.com/YunoHost-Apps/monitorix_ynh/issues>
|
||||||
|
|
||||||
## Developer info
|
## Developer info
|
||||||
|
|
||||||
Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/monitorix_ynh/tree/testing).
|
Please send your pull request to the [`testing` branch](https://github.com/YunoHost-Apps/monitorix_ynh/tree/testing).
|
||||||
|
|
||||||
To try the testing branch, please proceed like that.
|
To try the `testing` branch, please proceed like that:
|
||||||
|
|
||||||
``` bash
|
```bash
|
||||||
sudo yunohost app install https://github.com/YunoHost-Apps/monitorix_ynh/tree/testing --debug
|
sudo yunohost app install https://github.com/YunoHost-Apps/monitorix_ynh/tree/testing --debug
|
||||||
or
|
or
|
||||||
sudo yunohost app upgrade monitorix -u https://github.com/YunoHost-Apps/monitorix_ynh/tree/testing --debug
|
sudo yunohost app upgrade monitorix -u https://github.com/YunoHost-Apps/monitorix_ynh/tree/testing --debug
|
||||||
|
|
|
||||||
302
README_eu.md
Normal file
302
README_eu.md
Normal file
|
|
@ -0,0 +1,302 @@
|
||||||
|
<!--
|
||||||
|
Ohart ongi: README hau automatikoki sortu da <https://github.com/YunoHost/apps/tree/master/tools/readme_generator>ri esker
|
||||||
|
EZ editatu eskuz.
|
||||||
|
-->
|
||||||
|
|
||||||
|
# Monitorix YunoHost-erako
|
||||||
|
|
||||||
|
[](https://dash.yunohost.org/appci/app/monitorix)  
|
||||||
|
|
||||||
|
[](https://install-app.yunohost.org/?app=monitorix)
|
||||||
|
|
||||||
|
*[Irakurri README hau beste hizkuntzatan.](./ALL_README.md)*
|
||||||
|
|
||||||
|
> *Pakete honek Monitorix YunoHost zerbitzari batean azkar eta zailtasunik gabe instalatzea ahalbidetzen dizu.*
|
||||||
|
> *YunoHost ez baduzu, kontsultatu [gida](https://yunohost.org/install) nola instalatu ikasteko.*
|
||||||
|
|
||||||
|
## Aurreikuspena
|
||||||
|
|
||||||
|
Monitorix is a free, open source, lightweight system monitoring tool designed to monitor as many services and system resources as possible. It has been created to be used under production Linux/UNIX servers, but due to its simplicity and small size can be used on embedded devices as well.
|
||||||
|
|
||||||
|
|
||||||
|
**Paketatutako bertsioa:** 3.15.0~ynh3
|
||||||
|
|
||||||
|
**Demoa:** <https://www.fibranet.cat/monitorix/>
|
||||||
|
|
||||||
|
## Pantaila-argazkiak
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## Ezespena / informazio garrantzitsua
|
||||||
|
|
||||||
|
### Upgrade
|
||||||
|
|
||||||
|
By default, a backup is performed before upgrading. To avoid this, you have the following options:
|
||||||
|
- Pass the `NO_BACKUP_UPGRADE` env variable with `1` at each upgrade. For example `NO_BACKUP_UPGRADE=1 yunohost app upgrade monitorix`.
|
||||||
|
- Set `disable_backup_before_upgrade` to `1`. You can set it with this command:
|
||||||
|
|
||||||
|
`yunohost app setting monitorix disable_backup_before_upgrade -v 1`
|
||||||
|
|
||||||
|
After that, the settings will be applied for **all** the next updates.
|
||||||
|
|
||||||
|
From command line:
|
||||||
|
|
||||||
|
`yunohost app upgrade monitorix`
|
||||||
|
|
||||||
|
### Backup
|
||||||
|
|
||||||
|
This application now uses the core-only feature of the backup. To keep the integrity of the data and to have a better guarantee of the restoration it is recommended to proceed as follows:
|
||||||
|
|
||||||
|
- Stop Monitorix service with this command:
|
||||||
|
|
||||||
|
`systemctl stop monitorix.service`
|
||||||
|
|
||||||
|
- Launch Monitorix backup with this command:
|
||||||
|
|
||||||
|
`yunohost backup create --app monitorix`
|
||||||
|
|
||||||
|
- Backup your data with your specific strategy (could be with rsync, borg backup or just cp). The data is generally stored in `/var/lib/monitorix`.
|
||||||
|
- Restart Monitorix service with theses command:
|
||||||
|
|
||||||
|
`systemctl start monitorix.service`
|
||||||
|
|
||||||
|
### Remove
|
||||||
|
|
||||||
|
Due of the backup core only feature the data directory in `/var/lib/monitorix` **is not removed**. It must be manually deleted to purge user data from the app.
|
||||||
|
|
||||||
|
### More sensor
|
||||||
|
|
||||||
|
If you want to see the temperature of some sensor you can install the `lm-sensor` packet. For disk temperature you can instal the `hddtemp` packet.
|
||||||
|
|
||||||
|
### Custom config
|
||||||
|
|
||||||
|
If you want do custom the monitorix config for more personnal information you can add a file in `/etc/monitorix/conf.d/`. This config file will be overwritte the original config in `/etc/monitorix/monitorix.conf`.
|
||||||
|
|
||||||
|
You will have a full complete documentation for monitorix config here : https://www.monitorix.org/documentation.html
|
||||||
|
|
||||||
|
By example you can extends the basic config by this :
|
||||||
|
|
||||||
|
```
|
||||||
|
priority = 5
|
||||||
|
|
||||||
|
<graph_enable>
|
||||||
|
|
||||||
|
disk = y
|
||||||
|
lmsens = y
|
||||||
|
gensens = y
|
||||||
|
mail = y
|
||||||
|
</graph_enable>
|
||||||
|
|
||||||
|
# LMSENS graph
|
||||||
|
# -----------------------------------------------------------------------------
|
||||||
|
<lmsens>
|
||||||
|
<list>
|
||||||
|
core0 = temp1
|
||||||
|
core1 =
|
||||||
|
mb0 =
|
||||||
|
cpu0 =
|
||||||
|
fan0 =
|
||||||
|
fan1 =
|
||||||
|
fan2 =
|
||||||
|
volt0 =
|
||||||
|
volt1 =
|
||||||
|
volt2 =
|
||||||
|
volt3 =
|
||||||
|
volt4 =
|
||||||
|
volt5 =
|
||||||
|
volt6 =
|
||||||
|
volt7 =
|
||||||
|
</list>
|
||||||
|
</lmsns>
|
||||||
|
|
||||||
|
# GENSENS graph
|
||||||
|
# -----------------------------------------------------------------------------
|
||||||
|
<gensens>
|
||||||
|
<list>
|
||||||
|
0 = cpu_temp
|
||||||
|
1 = cpu0_freq, cpu1_freq, cpu2_freq, cpu3_freq
|
||||||
|
</list>
|
||||||
|
<desc>
|
||||||
|
cpu_temp = /sys/class/thermal/thermal_zone0/temp
|
||||||
|
cpu0_freq = /sys/devices/system/cpu/cpu0/cpufreq/cpuinfo_cur_freq
|
||||||
|
cpu1_freq = /sys/devices/system/cpu/cpu1/cpufreq/cpuinfo_cur_freq
|
||||||
|
cpu2_freq = /sys/devices/system/cpu/cpu2/cpufreq/cpuinfo_cur_freq
|
||||||
|
cpu3_freq = /sys/devices/system/cpu/cpu3/cpufreq/cpuinfo_cur_freq
|
||||||
|
</desc>
|
||||||
|
<unit>
|
||||||
|
cpu_temp = 1000
|
||||||
|
cpu0_freq = 0.001
|
||||||
|
cpu1_freq = 0.001
|
||||||
|
cpu2_freq = 0.001
|
||||||
|
cpu3_freq = 0.001
|
||||||
|
</unit>
|
||||||
|
<map>
|
||||||
|
cpu_temp = CPU Temperature
|
||||||
|
cpu0_freq = CPU 0 Frequency
|
||||||
|
cpu1_freq = CPU 1 Frequency
|
||||||
|
cpu2_freq = CPU 2 Frequency
|
||||||
|
cpu3_freq = CPU 3 Frequency
|
||||||
|
</map>
|
||||||
|
<alerts>
|
||||||
|
cpu_temp = 300, 65, /etc/monitorix/monitorix_alerts_scripts/cpu_temp.sh
|
||||||
|
</alerts>
|
||||||
|
</gensens>
|
||||||
|
|
||||||
|
# DISK graph
|
||||||
|
# -----------------------------------------------------------------------------
|
||||||
|
<disk>
|
||||||
|
<list>
|
||||||
|
0 = /dev/sda
|
||||||
|
</list>
|
||||||
|
<alerts>
|
||||||
|
realloc_enabled = y
|
||||||
|
realloc_timeintvl = 0
|
||||||
|
realloc_threshold = 1
|
||||||
|
realloc_script = /etc/monitorix/monitorix_alerts_scripts/disk_realloc.sh
|
||||||
|
pendsect_enabled = y
|
||||||
|
pendsect_timeintvl = 0
|
||||||
|
pendsect_threshold = 1
|
||||||
|
pendsect_script = /etc/monitorix/monitorix_alerts_scripts/disk_pendsect.sh
|
||||||
|
</alerts>
|
||||||
|
</disk>
|
||||||
|
|
||||||
|
# FS graph
|
||||||
|
# -----------------------------------------------------------------------------
|
||||||
|
<fs>
|
||||||
|
<list>
|
||||||
|
0 = /, /home, /var, /$tempdir, swap
|
||||||
|
</list>
|
||||||
|
<desc>
|
||||||
|
/ = Root FS
|
||||||
|
/home = home
|
||||||
|
/var = var
|
||||||
|
/$tempdir = tmp
|
||||||
|
</desc>
|
||||||
|
<devmap>
|
||||||
|
</devmap>
|
||||||
|
rigid = 2, 0, 2, 0
|
||||||
|
limit = 100, 1000, 100, 1000
|
||||||
|
<alerts>
|
||||||
|
/ = 3600, 98, /etc/monitorix/monitorix_alerts_scripts/fs_rootfs.sh
|
||||||
|
/home = 3600, 98, /etc/monitorix/monitorix_alerts_scripts/fs_home.sh
|
||||||
|
/var = 3600, 98, /etc/monitorix/monitorix_alerts_scripts/fs_var.sh
|
||||||
|
/$tempdir = 3600, 98, /etc/monitorix/monitorix_alerts_scripts/fs_tmp.sh
|
||||||
|
swap = 3600, 98, /etc/monitorix/monitorix_alerts_scripts/fs_swap.sh
|
||||||
|
</alerts>
|
||||||
|
</fs>
|
||||||
|
|
||||||
|
|
||||||
|
# MAIL graph
|
||||||
|
# -----------------------------------------------------------------------------
|
||||||
|
<mail>
|
||||||
|
mta = postfix
|
||||||
|
greylist = postgrey
|
||||||
|
stats_rate = real
|
||||||
|
rigid = 0, 0, 0, 0, 0
|
||||||
|
limit = 1, 1000, 1000, 1000, 1000
|
||||||
|
<alerts>
|
||||||
|
delvd_enabled = y
|
||||||
|
delvd_timeintvl = 60
|
||||||
|
delvd_threshold = 100
|
||||||
|
delvd_script = /etc/monitorix/monitorix_alerts_scripts/mail_delvd.sh
|
||||||
|
mqueued_enabled = y
|
||||||
|
mqueued_timeintvl = 3600
|
||||||
|
mqueued_threshold = 100
|
||||||
|
mqueued_script = /etc/monitorix/monitorix_alerts_scripts/mail_mqueued.sh
|
||||||
|
</alerts>
|
||||||
|
</mail>
|
||||||
|
|
||||||
|
|
||||||
|
# NET graph
|
||||||
|
# -----------------------------------------------------------------------------
|
||||||
|
<net>
|
||||||
|
list = eth0,lo
|
||||||
|
<desc>
|
||||||
|
eth0 = FastEthernet LAN, 0, 10000000
|
||||||
|
lo = loopback, 0, 10000000
|
||||||
|
</desc>
|
||||||
|
|
||||||
|
gateway = eth0
|
||||||
|
</net>
|
||||||
|
|
||||||
|
# PROCESS graph
|
||||||
|
# -----------------------------------------------------------------------------
|
||||||
|
<process>
|
||||||
|
<list>
|
||||||
|
0 = sshd, ntpd, monitorix, monitorix-httpd
|
||||||
|
1 = openvpn, ...
|
||||||
|
...
|
||||||
|
6 = mysqld, slapd, postgresql
|
||||||
|
</list>
|
||||||
|
<desc>
|
||||||
|
master = Postfix
|
||||||
|
imap = Dovecot
|
||||||
|
</desc>
|
||||||
|
rigid = 2, 0, 0, 0, 0, 0, 0, 0
|
||||||
|
limit = 100, 1000, 1000, 1000, 1000, 1000, 1000, 1000
|
||||||
|
</process>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<emailreports>
|
||||||
|
enabled = y
|
||||||
|
url_prefix = http://127.0.0.1:8081/monitorix
|
||||||
|
smtp_hostname = localhost
|
||||||
|
from_address = noreply@domain.tld
|
||||||
|
hour = 2
|
||||||
|
minute = 7
|
||||||
|
<daily>
|
||||||
|
enabled = y
|
||||||
|
graphs = system, fs, gensens, disk, netstat, port, nginx
|
||||||
|
to = user@domain.tld
|
||||||
|
</daily>
|
||||||
|
<weekly>
|
||||||
|
enabled = y
|
||||||
|
graphs = system, fs, gensens, disk, kern, proc, net, netstat, process, serv, port, user, nginx, mysql, fail2ban, int
|
||||||
|
to = user@domain.tld
|
||||||
|
</weekly>
|
||||||
|
<monthly>
|
||||||
|
enabled = y
|
||||||
|
graphs = system, fs, gensens, disk, kern, proc, net, netstat, process, serv, port, user, nginx, mysql, fail2ban, int
|
||||||
|
to = user@domain.tld
|
||||||
|
</monthly>
|
||||||
|
<yearly>
|
||||||
|
enabled = y
|
||||||
|
graphs = system, fs, gensens, disk, kern, proc, net, netstat, process, serv, port, user, nginx, mysql, fail2ban, int
|
||||||
|
to = user@domain.tld
|
||||||
|
</yearly>
|
||||||
|
</emailreports>
|
||||||
|
|
||||||
|
```
|
||||||
|
|
||||||
|
In this config we have :
|
||||||
|
- We set the process priority to 5 (which mean that it will be lower priority than the other process).
|
||||||
|
- We get the lmsensor sensor data.
|
||||||
|
- We get some sensors data not accessible with lmsensor (with gensens)
|
||||||
|
- We check the disk health and send an email if any error happens. For that you need to make some script. An example is available in `/usr/share/doc/monitorix/monitorix-alert.sh`.
|
||||||
|
- We check the filesystem.
|
||||||
|
- We check the traffic in the network card.
|
||||||
|
- We check some process.
|
||||||
|
- We send every day, week, month and year a rapport.
|
||||||
|
|
||||||
|
## Dokumentazioa eta baliabideak
|
||||||
|
|
||||||
|
- Aplikazioaren webgune ofiziala: <http://monitorix.org>
|
||||||
|
- Administratzaileen dokumentazio ofiziala: <https://www.monitorix.org/documentation.html>
|
||||||
|
- Jatorrizko aplikazioaren kode-gordailua: <https://github.com/mikaku/Monitorix>
|
||||||
|
- YunoHost Denda: <https://apps.yunohost.org/app/monitorix>
|
||||||
|
- Eman errore baten berri: <https://github.com/YunoHost-Apps/monitorix_ynh/issues>
|
||||||
|
|
||||||
|
## Garatzaileentzako informazioa
|
||||||
|
|
||||||
|
Bidali `pull request`a [`testing` abarrera](https://github.com/YunoHost-Apps/monitorix_ynh/tree/testing).
|
||||||
|
|
||||||
|
`testing` abarra probatzeko, ondorengoa egin:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
sudo yunohost app install https://github.com/YunoHost-Apps/monitorix_ynh/tree/testing --debug
|
||||||
|
edo
|
||||||
|
sudo yunohost app upgrade monitorix -u https://github.com/YunoHost-Apps/monitorix_ynh/tree/testing --debug
|
||||||
|
```
|
||||||
|
|
||||||
|
**Informazio gehiago aplikazioaren paketatzeari buruz:** <https://yunohost.org/packaging_apps>
|
||||||
32
README_fr.md
32
README_fr.md
|
|
@ -1,6 +1,6 @@
|
||||||
<!--
|
<!--
|
||||||
N.B.: This README was automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator
|
Nota bene : ce README est automatiquement généré par <https://github.com/YunoHost/apps/tree/master/tools/readme_generator>
|
||||||
It shall NOT be edited by hand.
|
Il NE doit PAS être modifié à la main.
|
||||||
-->
|
-->
|
||||||
|
|
||||||
# Monitorix pour YunoHost
|
# Monitorix pour YunoHost
|
||||||
|
|
@ -9,19 +9,19 @@ It shall NOT be edited by hand.
|
||||||
|
|
||||||
[](https://install-app.yunohost.org/?app=monitorix)
|
[](https://install-app.yunohost.org/?app=monitorix)
|
||||||
|
|
||||||
*[Read this readme in english.](./README.md)*
|
*[Lire le README dans d'autres langues.](./ALL_README.md)*
|
||||||
|
|
||||||
> *Ce package vous permet d’installer Monitorix rapidement et simplement sur un serveur YunoHost.
|
> *Ce package vous permet d’installer Monitorix rapidement et simplement sur un serveur YunoHost.*
|
||||||
Si vous n’avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour savoir comment l’installer et en profiter.*
|
> *Si vous n’avez pas YunoHost, consultez [ce guide](https://yunohost.org/install) pour savoir comment l’installer et en profiter.*
|
||||||
|
|
||||||
## Vue d’ensemble
|
## Vue d’ensemble
|
||||||
|
|
||||||
Monitorix is a free, open source, lightweight system monitoring tool designed to monitor as many services and system resources as possible. It has been created to be used under production Linux/UNIX servers, but due to its simplicity and small size can be used on embedded devices as well.
|
Monitorix is a free, open source, lightweight system monitoring tool designed to monitor as many services and system resources as possible. It has been created to be used under production Linux/UNIX servers, but due to its simplicity and small size can be used on embedded devices as well.
|
||||||
|
|
||||||
|
|
||||||
**Version incluse :** 3.15.0~ynh3
|
**Version incluse :** 3.15.0~ynh3
|
||||||
|
|
||||||
**Démo :** https://www.fibranet.cat/monitorix/
|
**Démo :** <https://www.fibranet.cat/monitorix/>
|
||||||
|
|
||||||
## Captures d’écran
|
## Captures d’écran
|
||||||
|
|
||||||
|
|
@ -281,22 +281,22 @@ In this config we have :
|
||||||
|
|
||||||
## Documentations et ressources
|
## Documentations et ressources
|
||||||
|
|
||||||
* Site officiel de l’app : <http://monitorix.org>
|
- Site officiel de l’app : <http://monitorix.org>
|
||||||
* Documentation officielle de l’admin : <https://www.monitorix.org/documentation.html>
|
- Documentation officielle de l’admin : <https://www.monitorix.org/documentation.html>
|
||||||
* Dépôt de code officiel de l’app : <https://github.com/mikaku/Monitorix>
|
- Dépôt de code officiel de l’app : <https://github.com/mikaku/Monitorix>
|
||||||
* YunoHost Store: <https://apps.yunohost.org/app/monitorix>
|
- YunoHost Store : <https://apps.yunohost.org/app/monitorix>
|
||||||
* Signaler un bug : <https://github.com/YunoHost-Apps/monitorix_ynh/issues>
|
- Signaler un bug : <https://github.com/YunoHost-Apps/monitorix_ynh/issues>
|
||||||
|
|
||||||
## Informations pour les développeurs
|
## Informations pour les développeurs
|
||||||
|
|
||||||
Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/monitorix_ynh/tree/testing).
|
Merci de faire vos pull request sur la [branche `testing`](https://github.com/YunoHost-Apps/monitorix_ynh/tree/testing).
|
||||||
|
|
||||||
Pour essayer la branche testing, procédez comme suit.
|
Pour essayer la branche `testing`, procédez comme suit :
|
||||||
|
|
||||||
``` bash
|
```bash
|
||||||
sudo yunohost app install https://github.com/YunoHost-Apps/monitorix_ynh/tree/testing --debug
|
sudo yunohost app install https://github.com/YunoHost-Apps/monitorix_ynh/tree/testing --debug
|
||||||
ou
|
ou
|
||||||
sudo yunohost app upgrade monitorix -u https://github.com/YunoHost-Apps/monitorix_ynh/tree/testing --debug
|
sudo yunohost app upgrade monitorix -u https://github.com/YunoHost-Apps/monitorix_ynh/tree/testing --debug
|
||||||
```
|
```
|
||||||
|
|
||||||
**Plus d’infos sur le packaging d’applications :** <https://yunohost.org/packaging_apps>
|
**Plus d’infos sur le packaging d’applications :** <https://yunohost.org/packaging_apps>
|
||||||
|
|
|
||||||
302
README_gl.md
Normal file
302
README_gl.md
Normal file
|
|
@ -0,0 +1,302 @@
|
||||||
|
<!--
|
||||||
|
NOTA: Este README foi creado automáticamente por <https://github.com/YunoHost/apps/tree/master/tools/readme_generator>
|
||||||
|
NON debe editarse manualmente.
|
||||||
|
-->
|
||||||
|
|
||||||
|
# Monitorix para YunoHost
|
||||||
|
|
||||||
|
[](https://dash.yunohost.org/appci/app/monitorix)  
|
||||||
|
|
||||||
|
[](https://install-app.yunohost.org/?app=monitorix)
|
||||||
|
|
||||||
|
*[Le este README en outros idiomas.](./ALL_README.md)*
|
||||||
|
|
||||||
|
> *Este paquete permíteche instalar Monitorix de xeito rápido e doado nun servidor YunoHost.*
|
||||||
|
> *Se non usas YunoHost, le a [documentación](https://yunohost.org/install) para saber como instalalo.*
|
||||||
|
|
||||||
|
## Vista xeral
|
||||||
|
|
||||||
|
Monitorix is a free, open source, lightweight system monitoring tool designed to monitor as many services and system resources as possible. It has been created to be used under production Linux/UNIX servers, but due to its simplicity and small size can be used on embedded devices as well.
|
||||||
|
|
||||||
|
|
||||||
|
**Versión proporcionada:** 3.15.0~ynh3
|
||||||
|
|
||||||
|
**Demo:** <https://www.fibranet.cat/monitorix/>
|
||||||
|
|
||||||
|
## Capturas de pantalla
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## Avisos / información importante
|
||||||
|
|
||||||
|
### Upgrade
|
||||||
|
|
||||||
|
By default, a backup is performed before upgrading. To avoid this, you have the following options:
|
||||||
|
- Pass the `NO_BACKUP_UPGRADE` env variable with `1` at each upgrade. For example `NO_BACKUP_UPGRADE=1 yunohost app upgrade monitorix`.
|
||||||
|
- Set `disable_backup_before_upgrade` to `1`. You can set it with this command:
|
||||||
|
|
||||||
|
`yunohost app setting monitorix disable_backup_before_upgrade -v 1`
|
||||||
|
|
||||||
|
After that, the settings will be applied for **all** the next updates.
|
||||||
|
|
||||||
|
From command line:
|
||||||
|
|
||||||
|
`yunohost app upgrade monitorix`
|
||||||
|
|
||||||
|
### Backup
|
||||||
|
|
||||||
|
This application now uses the core-only feature of the backup. To keep the integrity of the data and to have a better guarantee of the restoration it is recommended to proceed as follows:
|
||||||
|
|
||||||
|
- Stop Monitorix service with this command:
|
||||||
|
|
||||||
|
`systemctl stop monitorix.service`
|
||||||
|
|
||||||
|
- Launch Monitorix backup with this command:
|
||||||
|
|
||||||
|
`yunohost backup create --app monitorix`
|
||||||
|
|
||||||
|
- Backup your data with your specific strategy (could be with rsync, borg backup or just cp). The data is generally stored in `/var/lib/monitorix`.
|
||||||
|
- Restart Monitorix service with theses command:
|
||||||
|
|
||||||
|
`systemctl start monitorix.service`
|
||||||
|
|
||||||
|
### Remove
|
||||||
|
|
||||||
|
Due of the backup core only feature the data directory in `/var/lib/monitorix` **is not removed**. It must be manually deleted to purge user data from the app.
|
||||||
|
|
||||||
|
### More sensor
|
||||||
|
|
||||||
|
If you want to see the temperature of some sensor you can install the `lm-sensor` packet. For disk temperature you can instal the `hddtemp` packet.
|
||||||
|
|
||||||
|
### Custom config
|
||||||
|
|
||||||
|
If you want do custom the monitorix config for more personnal information you can add a file in `/etc/monitorix/conf.d/`. This config file will be overwritte the original config in `/etc/monitorix/monitorix.conf`.
|
||||||
|
|
||||||
|
You will have a full complete documentation for monitorix config here : https://www.monitorix.org/documentation.html
|
||||||
|
|
||||||
|
By example you can extends the basic config by this :
|
||||||
|
|
||||||
|
```
|
||||||
|
priority = 5
|
||||||
|
|
||||||
|
<graph_enable>
|
||||||
|
|
||||||
|
disk = y
|
||||||
|
lmsens = y
|
||||||
|
gensens = y
|
||||||
|
mail = y
|
||||||
|
</graph_enable>
|
||||||
|
|
||||||
|
# LMSENS graph
|
||||||
|
# -----------------------------------------------------------------------------
|
||||||
|
<lmsens>
|
||||||
|
<list>
|
||||||
|
core0 = temp1
|
||||||
|
core1 =
|
||||||
|
mb0 =
|
||||||
|
cpu0 =
|
||||||
|
fan0 =
|
||||||
|
fan1 =
|
||||||
|
fan2 =
|
||||||
|
volt0 =
|
||||||
|
volt1 =
|
||||||
|
volt2 =
|
||||||
|
volt3 =
|
||||||
|
volt4 =
|
||||||
|
volt5 =
|
||||||
|
volt6 =
|
||||||
|
volt7 =
|
||||||
|
</list>
|
||||||
|
</lmsns>
|
||||||
|
|
||||||
|
# GENSENS graph
|
||||||
|
# -----------------------------------------------------------------------------
|
||||||
|
<gensens>
|
||||||
|
<list>
|
||||||
|
0 = cpu_temp
|
||||||
|
1 = cpu0_freq, cpu1_freq, cpu2_freq, cpu3_freq
|
||||||
|
</list>
|
||||||
|
<desc>
|
||||||
|
cpu_temp = /sys/class/thermal/thermal_zone0/temp
|
||||||
|
cpu0_freq = /sys/devices/system/cpu/cpu0/cpufreq/cpuinfo_cur_freq
|
||||||
|
cpu1_freq = /sys/devices/system/cpu/cpu1/cpufreq/cpuinfo_cur_freq
|
||||||
|
cpu2_freq = /sys/devices/system/cpu/cpu2/cpufreq/cpuinfo_cur_freq
|
||||||
|
cpu3_freq = /sys/devices/system/cpu/cpu3/cpufreq/cpuinfo_cur_freq
|
||||||
|
</desc>
|
||||||
|
<unit>
|
||||||
|
cpu_temp = 1000
|
||||||
|
cpu0_freq = 0.001
|
||||||
|
cpu1_freq = 0.001
|
||||||
|
cpu2_freq = 0.001
|
||||||
|
cpu3_freq = 0.001
|
||||||
|
</unit>
|
||||||
|
<map>
|
||||||
|
cpu_temp = CPU Temperature
|
||||||
|
cpu0_freq = CPU 0 Frequency
|
||||||
|
cpu1_freq = CPU 1 Frequency
|
||||||
|
cpu2_freq = CPU 2 Frequency
|
||||||
|
cpu3_freq = CPU 3 Frequency
|
||||||
|
</map>
|
||||||
|
<alerts>
|
||||||
|
cpu_temp = 300, 65, /etc/monitorix/monitorix_alerts_scripts/cpu_temp.sh
|
||||||
|
</alerts>
|
||||||
|
</gensens>
|
||||||
|
|
||||||
|
# DISK graph
|
||||||
|
# -----------------------------------------------------------------------------
|
||||||
|
<disk>
|
||||||
|
<list>
|
||||||
|
0 = /dev/sda
|
||||||
|
</list>
|
||||||
|
<alerts>
|
||||||
|
realloc_enabled = y
|
||||||
|
realloc_timeintvl = 0
|
||||||
|
realloc_threshold = 1
|
||||||
|
realloc_script = /etc/monitorix/monitorix_alerts_scripts/disk_realloc.sh
|
||||||
|
pendsect_enabled = y
|
||||||
|
pendsect_timeintvl = 0
|
||||||
|
pendsect_threshold = 1
|
||||||
|
pendsect_script = /etc/monitorix/monitorix_alerts_scripts/disk_pendsect.sh
|
||||||
|
</alerts>
|
||||||
|
</disk>
|
||||||
|
|
||||||
|
# FS graph
|
||||||
|
# -----------------------------------------------------------------------------
|
||||||
|
<fs>
|
||||||
|
<list>
|
||||||
|
0 = /, /home, /var, /$tempdir, swap
|
||||||
|
</list>
|
||||||
|
<desc>
|
||||||
|
/ = Root FS
|
||||||
|
/home = home
|
||||||
|
/var = var
|
||||||
|
/$tempdir = tmp
|
||||||
|
</desc>
|
||||||
|
<devmap>
|
||||||
|
</devmap>
|
||||||
|
rigid = 2, 0, 2, 0
|
||||||
|
limit = 100, 1000, 100, 1000
|
||||||
|
<alerts>
|
||||||
|
/ = 3600, 98, /etc/monitorix/monitorix_alerts_scripts/fs_rootfs.sh
|
||||||
|
/home = 3600, 98, /etc/monitorix/monitorix_alerts_scripts/fs_home.sh
|
||||||
|
/var = 3600, 98, /etc/monitorix/monitorix_alerts_scripts/fs_var.sh
|
||||||
|
/$tempdir = 3600, 98, /etc/monitorix/monitorix_alerts_scripts/fs_tmp.sh
|
||||||
|
swap = 3600, 98, /etc/monitorix/monitorix_alerts_scripts/fs_swap.sh
|
||||||
|
</alerts>
|
||||||
|
</fs>
|
||||||
|
|
||||||
|
|
||||||
|
# MAIL graph
|
||||||
|
# -----------------------------------------------------------------------------
|
||||||
|
<mail>
|
||||||
|
mta = postfix
|
||||||
|
greylist = postgrey
|
||||||
|
stats_rate = real
|
||||||
|
rigid = 0, 0, 0, 0, 0
|
||||||
|
limit = 1, 1000, 1000, 1000, 1000
|
||||||
|
<alerts>
|
||||||
|
delvd_enabled = y
|
||||||
|
delvd_timeintvl = 60
|
||||||
|
delvd_threshold = 100
|
||||||
|
delvd_script = /etc/monitorix/monitorix_alerts_scripts/mail_delvd.sh
|
||||||
|
mqueued_enabled = y
|
||||||
|
mqueued_timeintvl = 3600
|
||||||
|
mqueued_threshold = 100
|
||||||
|
mqueued_script = /etc/monitorix/monitorix_alerts_scripts/mail_mqueued.sh
|
||||||
|
</alerts>
|
||||||
|
</mail>
|
||||||
|
|
||||||
|
|
||||||
|
# NET graph
|
||||||
|
# -----------------------------------------------------------------------------
|
||||||
|
<net>
|
||||||
|
list = eth0,lo
|
||||||
|
<desc>
|
||||||
|
eth0 = FastEthernet LAN, 0, 10000000
|
||||||
|
lo = loopback, 0, 10000000
|
||||||
|
</desc>
|
||||||
|
|
||||||
|
gateway = eth0
|
||||||
|
</net>
|
||||||
|
|
||||||
|
# PROCESS graph
|
||||||
|
# -----------------------------------------------------------------------------
|
||||||
|
<process>
|
||||||
|
<list>
|
||||||
|
0 = sshd, ntpd, monitorix, monitorix-httpd
|
||||||
|
1 = openvpn, ...
|
||||||
|
...
|
||||||
|
6 = mysqld, slapd, postgresql
|
||||||
|
</list>
|
||||||
|
<desc>
|
||||||
|
master = Postfix
|
||||||
|
imap = Dovecot
|
||||||
|
</desc>
|
||||||
|
rigid = 2, 0, 0, 0, 0, 0, 0, 0
|
||||||
|
limit = 100, 1000, 1000, 1000, 1000, 1000, 1000, 1000
|
||||||
|
</process>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<emailreports>
|
||||||
|
enabled = y
|
||||||
|
url_prefix = http://127.0.0.1:8081/monitorix
|
||||||
|
smtp_hostname = localhost
|
||||||
|
from_address = noreply@domain.tld
|
||||||
|
hour = 2
|
||||||
|
minute = 7
|
||||||
|
<daily>
|
||||||
|
enabled = y
|
||||||
|
graphs = system, fs, gensens, disk, netstat, port, nginx
|
||||||
|
to = user@domain.tld
|
||||||
|
</daily>
|
||||||
|
<weekly>
|
||||||
|
enabled = y
|
||||||
|
graphs = system, fs, gensens, disk, kern, proc, net, netstat, process, serv, port, user, nginx, mysql, fail2ban, int
|
||||||
|
to = user@domain.tld
|
||||||
|
</weekly>
|
||||||
|
<monthly>
|
||||||
|
enabled = y
|
||||||
|
graphs = system, fs, gensens, disk, kern, proc, net, netstat, process, serv, port, user, nginx, mysql, fail2ban, int
|
||||||
|
to = user@domain.tld
|
||||||
|
</monthly>
|
||||||
|
<yearly>
|
||||||
|
enabled = y
|
||||||
|
graphs = system, fs, gensens, disk, kern, proc, net, netstat, process, serv, port, user, nginx, mysql, fail2ban, int
|
||||||
|
to = user@domain.tld
|
||||||
|
</yearly>
|
||||||
|
</emailreports>
|
||||||
|
|
||||||
|
```
|
||||||
|
|
||||||
|
In this config we have :
|
||||||
|
- We set the process priority to 5 (which mean that it will be lower priority than the other process).
|
||||||
|
- We get the lmsensor sensor data.
|
||||||
|
- We get some sensors data not accessible with lmsensor (with gensens)
|
||||||
|
- We check the disk health and send an email if any error happens. For that you need to make some script. An example is available in `/usr/share/doc/monitorix/monitorix-alert.sh`.
|
||||||
|
- We check the filesystem.
|
||||||
|
- We check the traffic in the network card.
|
||||||
|
- We check some process.
|
||||||
|
- We send every day, week, month and year a rapport.
|
||||||
|
|
||||||
|
## Documentación e recursos
|
||||||
|
|
||||||
|
- Web oficial da app: <http://monitorix.org>
|
||||||
|
- Documentación oficial para admin: <https://www.monitorix.org/documentation.html>
|
||||||
|
- Repositorio de orixe do código: <https://github.com/mikaku/Monitorix>
|
||||||
|
- Tenda YunoHost: <https://apps.yunohost.org/app/monitorix>
|
||||||
|
- Informar dun problema: <https://github.com/YunoHost-Apps/monitorix_ynh/issues>
|
||||||
|
|
||||||
|
## Info de desenvolvemento
|
||||||
|
|
||||||
|
Envía a túa colaboración á [rama `testing`](https://github.com/YunoHost-Apps/monitorix_ynh/tree/testing).
|
||||||
|
|
||||||
|
Para probar a rama `testing`, procede deste xeito:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
sudo yunohost app install https://github.com/YunoHost-Apps/monitorix_ynh/tree/testing --debug
|
||||||
|
ou
|
||||||
|
sudo yunohost app upgrade monitorix -u https://github.com/YunoHost-Apps/monitorix_ynh/tree/testing --debug
|
||||||
|
```
|
||||||
|
|
||||||
|
**Máis info sobre o empaquetado da app:** <https://yunohost.org/packaging_apps>
|
||||||
Loading…
Add table
Reference in a new issue