diff --git a/README.md b/README.md index 94633a2..766cbc2 100644 --- a/README.md +++ b/README.md @@ -1,54 +1,32 @@ -Monitorix For yunohost -====================== + -[![Integration level](https://dash.yunohost.org/integration/monitorix.svg)](https://dash.yunohost.org/appci/app/monitorix) ![](https://ci-apps.yunohost.org/ci/badges/monitorix.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/monitorix.maintain.svg) -[![Install monitorix with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=monitorix) +# Monitorix for YunoHost -> *This package allow you to install monitorix quickly and simply on a YunoHost server. -If you don't have YunoHost, please see [here](https://yunohost.org/#/install) to know how to install and enjoy it.* +[![Integration level](https://dash.yunohost.org/integration/monitorix.svg)](https://dash.yunohost.org/appci/app/monitorix) ![Working status](https://ci-apps.yunohost.org/ci/badges/monitorix.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/monitorix.maintain.svg) +[![Install Monitorix with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=monitorix) -Overview --------- +*[Lire ce readme en français.](./README_fr.md)* + +> *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.* + +## Overview 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. -**Shipped version:** 3.13.1 -Screenshots ------------ +**Shipped version:** 3.14.0~ynh2 -![](https://www.monitorix.org/imgs/mail.png) +**Demo:** https://www.fibranet.cat/monitorix/ -Demo ----- +## Screenshots -* [Official demo](https://www.fibranet.cat/monitorix/) +![Screenshot of Monitorix](./doc/screenshots/mail.png) -Documentation -------------- - - * Official documentation: https://www.monitorix.org/documentation.html - * YunoHost documentation: There no other documentations, feel free to contribute. - -YunoHost specific features --------------------------- - -### Multi-users support - -This app have no specific authentification and no specific user management. - -### Supported architectures - -* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/monitorix%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/monitorix/) -* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/monitorix%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/monitorix/) - - - -Additional informations ------------------------ +## Disclaimers / important information ### More sensor @@ -150,13 +128,13 @@ priority = 5 # ----------------------------------------------------------------------------- - 0 = /, /home, /var, /tmp, swap + 0 = /, /home, /var, /$tempdir, swap / = Root FS /home = home /var = var - /tmp = tmp + /$tempdir = tmp @@ -166,7 +144,7 @@ priority = 5 / = 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 - /tmp = 3600, 98, /etc/monitorix/monitorix_alerts_scripts/fs_tmp.sh + /$tempdir = 3600, 98, /etc/monitorix/monitorix_alerts_scripts/fs_tmp.sh swap = 3600, 98, /etc/monitorix/monitorix_alerts_scripts/fs_swap.sh @@ -265,40 +243,24 @@ In this config we have : - We check some process. - We send every day, week, month and year a rapport. -Links ------ +## Documentation and resources - * Report a bug: https://github.com/YunoHost-Apps/monitorix_ynh/issues - * App website: Link to the official website of this app - * YunoHost website: https://yunohost.org/ +* Official app website: +* Official admin documentation: +* Upstream app code repository: +* YunoHost documentation for this app: +* Report a bug: ---- +## Developer info -Install -------- - -From command line: - -`sudo yunohost app install -l monitorix https://github.com/YunoHost-Apps/monitorix_ynh` - -Upgrade -------- - -From command line: - -`sudo yunohost app upgrade monitorix -u https://github.com/YunoHost-Apps/monitorix_ynh` - -Developers infos ----------------- +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. -``` + +``` bash sudo yunohost app install https://github.com/YunoHost-Apps/monitorix_ynh/tree/testing --debug or sudo yunohost app upgrade monitorix -u https://github.com/YunoHost-Apps/monitorix_ynh/tree/testing --debug ``` -License -------- - -Monitorix is published under the GNU General Public License v2.0 License : http://www.monitorix.org/license.html +**More info regarding app packaging:** diff --git a/README_fr.md b/README_fr.md new file mode 100644 index 0000000..1b0ded6 --- /dev/null +++ b/README_fr.md @@ -0,0 +1,266 @@ + + +# Monitorix pour YunoHost + +[![Niveau d'intégration](https://dash.yunohost.org/integration/monitorix.svg)](https://dash.yunohost.org/appci/app/monitorix) ![Statut du fonctionnement](https://ci-apps.yunohost.org/ci/badges/monitorix.status.svg) ![Statut de maintenance](https://ci-apps.yunohost.org/ci/badges/monitorix.maintain.svg) +[![Installer Monitorix avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=monitorix) + +*[Read this readme in english.](./README.md)* + +> *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.* + +## 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. + + +**Version incluse :** 3.14.0~ynh2 + +**Démo :** https://www.fibranet.cat/monitorix/ + +## Captures d'écran + +![Capture d'écran de Monitorix](./doc/screenshots/mail.png) + +## Avertissements / informations importantes + +### 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 + + + + disk = y + lmsens = y + gensens = y + mail = y + + +# LMSENS graph +# ----------------------------------------------------------------------------- + + + core0 = temp1 + core1 = + mb0 = + cpu0 = + fan0 = + fan1 = + fan2 = + volt0 = + volt1 = + volt2 = + volt3 = + volt4 = + volt5 = + volt6 = + volt7 = + + + +# GENSENS graph +# ----------------------------------------------------------------------------- + + + 0 = cpu_temp + 1 = cpu0_freq, cpu1_freq, cpu2_freq, cpu3_freq + + + 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 + + + cpu_temp = 1000 + cpu0_freq = 0.001 + cpu1_freq = 0.001 + cpu2_freq = 0.001 + cpu3_freq = 0.001 + + + cpu_temp = CPU Temperature + cpu0_freq = CPU 0 Frequency + cpu1_freq = CPU 1 Frequency + cpu2_freq = CPU 2 Frequency + cpu3_freq = CPU 3 Frequency + + + cpu_temp = 300, 65, /etc/monitorix/monitorix_alerts_scripts/cpu_temp.sh + + + +# DISK graph +# ----------------------------------------------------------------------------- + + + 0 = /dev/sda + + + 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 + + + +# FS graph +# ----------------------------------------------------------------------------- + + + 0 = /, /home, /var, /$tempdir, swap + + + / = Root FS + /home = home + /var = var + /$tempdir = tmp + + + + rigid = 2, 0, 2, 0 + limit = 100, 1000, 100, 1000 + + / = 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 + + + + +# MAIL graph +# ----------------------------------------------------------------------------- + + mta = postfix + greylist = postgrey + stats_rate = real + rigid = 0, 0, 0, 0, 0 + limit = 1, 1000, 1000, 1000, 1000 + + 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 + + + + +# NET graph +# ----------------------------------------------------------------------------- + + list = eth0,lo + + eth0 = FastEthernet LAN, 0, 10000000 + lo = loopback, 0, 10000000 + + + gateway = eth0 + + +# PROCESS graph +# ----------------------------------------------------------------------------- + + + 0 = sshd, ntpd, monitorix, monitorix-httpd + 1 = openvpn, ... + ... + 6 = mysqld, slapd, postgresql + + + master = Postfix + imap = Dovecot + + rigid = 2, 0, 0, 0, 0, 0, 0, 0 + limit = 100, 1000, 1000, 1000, 1000, 1000, 1000, 1000 + + + + + + enabled = y + url_prefix = http://127.0.0.1:8081/monitorix + smtp_hostname = localhost + from_address = noreply@domain.tld + hour = 2 + minute = 7 + + enabled = y + graphs = system, fs, gensens, disk, netstat, port, nginx + to = user@domain.tld + + + enabled = y + graphs = system, fs, gensens, disk, kern, proc, net, netstat, process, serv, port, user, nginx, mysql, fail2ban, int + to = user@domain.tld + + + enabled = y + graphs = system, fs, gensens, disk, kern, proc, net, netstat, process, serv, port, user, nginx, mysql, fail2ban, int + to = user@domain.tld + + + enabled = y + graphs = system, fs, gensens, disk, kern, proc, net, netstat, process, serv, port, user, nginx, mysql, fail2ban, int + to = user@domain.tld + + + +``` + +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. + +## Documentations et ressources + +* Site officiel de l'app : +* Documentation officielle de l'admin : +* Dépôt de code officiel de l'app : +* Documentation YunoHost pour cette app : +* Signaler un bug : + +## Informations pour les développeurs + +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. + +``` 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 +``` + +**Plus d'infos sur le packaging d'applications :**