diff --git a/en_US/faq/file.locations.md b/en_US/faq/file.locations.md index 18f521b0..7e49ecbb 100644 --- a/en_US/faq/file.locations.md +++ b/en_US/faq/file.locations.md @@ -48,7 +48,7 @@ The self-signed SSL certificate generated during iRedMail installation: ## Dovecot {: #dovecot } -* on `Linux` and OpenBSD, Dovecot config files are placed under `/etc/dovecot/`. +* on Linux and OpenBSD, Dovecot config files are placed under `/etc/dovecot/`. * on FreeBSD, Dovecot config files are placed under `/usr/local/etc/dovecot/`. ### Config files {: #dovecot-config } diff --git a/en_US/integrations/0-integration.netdata.linux.md b/en_US/integrations/0-integration.netdata.linux.md index 38dd0843..726a6b6f 100644 --- a/en_US/integrations/0-integration.netdata.linux.md +++ b/en_US/integrations/0-integration.netdata.linux.md @@ -88,8 +88,15 @@ used by iRedMail: netdata ships a lot modular config files to gather information of softwares running on the server, they have very good default settings and most config -files don't need your attention at all. but some applications do require -extra settings. +files don't need your attention at all, including: + +* System resources (CPU, RAM, disk I/O, etc) +* Nginx log file monitoring +* Fail2ban jails +* Memcached +* ... + +But some applications do require extra settings, we will cover them below. ### Monitor Nginx and php-fpm @@ -144,8 +151,48 @@ pm.status_path = /status * Restart both php-fpm and Nginx service. -### [TODO] Monitor Dovecot +### Monitor Dovecot +We need to enable statistics module in Dovecot. + +* Please open Dovecot config file: + * on Linux and OpenBSD, its `/etc/dovecot/dovecot.conf`. + * on FreeBSD, it's `/usr/local/etc/dovecot/dovecot.conf`. + +* Append plugin `stats` in global parameter `mail_plugins`, and `imap_stats` + for imap protocol: + +``` +mail_plugins = ... stats + +protocol imap { + mail_plugins = ... imap_stats +``` + +* Append settings below in Dovecot config file: + +``` +plugin { + # how often to session statistics (must be set) + stats_refresh = 30 secs + # track per-IMAP command statistics (optional) + stats_track_cmds = yes +} + +service stats { + fifo_listener stats-mail { + user = vmail + mode = 0644 + } + + inet_listener { + address = 127.0.0.1 + port = 24242 + } +} +``` + +* Restart Dovecot service. ### Monitor MySQL/MariaDB server diff --git a/html/file.locations.html b/html/file.locations.html index 3ecfac5a..2b1b8209 100644 --- a/html/file.locations.html +++ b/html/file.locations.html @@ -105,7 +105,7 @@

Dovecot

Config files

diff --git a/html/integration.netdata.linux.html b/html/integration.netdata.linux.html index c26e6bd8..2d82d2f3 100644 --- a/html/integration.netdata.linux.html +++ b/html/integration.netdata.linux.html @@ -24,7 +24,7 @@
  • Install netdata
  • Configure netdata @@ -111,8 +111,15 @@ used by iRedMail:

    netdata ships a lot modular config files to gather information of softwares running on the server, they have very good default settings and most config -files don't need your attention at all. but some applications do require -extra settings.

    +files don't need your attention at all, including:

    + +

    But some applications do require extra settings, we will cover them below.

    Monitor Nginx and php-fpm

    We need to enable stub_status in Nginx to get detailed server info, also update php-fpm config file to enable similar feature.

    @@ -167,7 +174,53 @@ location = /status { -

    [TODO] Monitor Dovecot

    +

    Monitor Dovecot

    +

    We need to enable statistics module in Dovecot.

    + +
    mail_plugins = ... stats
    +
    +protocol imap {
    +    mail_plugins = ... imap_stats
    +
    + + +
    plugin {
    +    # how often to session statistics (must be set)
    +    stats_refresh = 30 secs
    +    # track per-IMAP command statistics (optional)
    +    stats_track_cmds = yes
    +}
    +
    +service stats {
    +    fifo_listener stats-mail {
    +        user = vmail
    +        mode = 0644
    +    }
    +
    +    inet_listener {
    +        address = 127.0.0.1
    +        port = 24242
    +    }
    +}
    +
    + +

    Monitor MySQL/MariaDB server

    netdata requires a SQL user (we use netdata here) with privilege USAGE to gather MySQL server information.