diff --git a/en_US/iredmail-easy/2-iredmail-easy.best.practice.md b/en_US/iredmail-easy/2-iredmail-easy.best.practice.md index ebf76881..937572a0 100644 --- a/en_US/iredmail-easy/2-iredmail-easy.best.practice.md +++ b/en_US/iredmail-easy/2-iredmail-easy.best.practice.md @@ -285,21 +285,63 @@ overrode by the last one. ### Roundcube -- File `/opt/iredmail/custom/roundcube/custom.inc.php` +#### Custom global settings - All your custom settings should be placed in this file, and do __NOT__ + All your custom settings should be placed in + __`/opt/iredmail/custom/roundcube/custom.inc.php`__, and do __NOT__ touch main config file `/opt/www/roundcubemail/config/config.inc.php`. -- Directory `/opt/iredmail/custom/roundcube/plugins/` +#### Third-party or custom plugins + + All third-party or custom plugins should be placed under __`/opt/iredmail/custom/roundcube/plugins/`__. - All third-party or custom plugins should be placed under this directory. Plugins will be linked to `/opt/www/roundcubemail/plugins/` automatically during iRedMail Easy deployment, but you need to create the symbol link manually if you don't want to run another deployment. -- Directory `/opt/iredmail/custom/roundcube/skins/` +#### Custom settings for official plugins + + iRedMail Easy enables 2 official plugins by default: + + - `password`: used by end users to change their own passwords. + - `managesieve`: used by end users to custom mail filter rules. + + If you have custom settings for plugins enabled by iRedMail Easy, please + put the custom settings in file + `/opt/iredmail/custom/roundcube/config_.inc.php`. + + For example: + + - For `password` plugin: `/opt/iredmail/custom/roundcube/config_password.inc.php` + - For `managesieve` plugin: `/opt/iredmail/custom/roundcube/config_managesieve.inc.php` + + If you have custom settings for plugin which is not enabled by iRedMail + Easy, please append a line to + `/opt/www/roundcubemail/plugins//config.inc.php` like below: + + ``` + require_once "/opt/iredmail/custom/roundcube/config_.inc.php"; + ``` + + Then put all custom settings for this plugin to `/opt/iredmail/custom/roundcube/config_.inc.php`. + + For example, if you have custom settings for official plugin `enigma`, you + should append this line to `/opt/www/roundcubemail/plugins/enigma/config.inc.php`: + + ``` + require_once "/opt/iredmail/custom/roundcube/config_enigma.inc.php"; + ``` + + Then put all custom settings for plugin `enigma` to + `/opt/iredmail/custom/roundcube/config_enigma.inc.php`. + + This way if iRedMail Easy enables the plugin, it will successfully load + your own custom settings and not mess it up. + +#### Custom skins + + All third-party or custom skins should be placed under __`/opt/iredmail/custom/roundcube/skins/`__. - All third-party or custom skins should be placed under this directory. Skins will be linked to `/opt/www/roundcubemail/skins/` automatically during iRedMail Easy deployment, but you need to create the symbol link manually if you don't want to run another deployment. diff --git a/html/iredmail-easy.best.practice.html b/html/iredmail-easy.best.practice.html index 2d65afc4..7072d05a 100644 --- a/html/iredmail-easy.best.practice.html +++ b/html/iredmail-easy.best.practice.html @@ -33,7 +33,13 @@
  • Nginx
  • Postfix
  • Dovecot
  • -
  • Roundcube
  • +
  • Roundcube +
  • SOGo
  • iRedAPD
  • iRedAdmin
  • @@ -400,27 +406,63 @@ overrode by the last one.

  • /opt/iredmail/custom/dovecot/custom.sh: a bash shell script used for advanced customization
  • Roundcube

    -
      -
    • -

      File /opt/iredmail/custom/roundcube/custom.inc.php

      -

      All your custom settings should be placed in this file, and do NOT -touch main config file /opt/www/roundcubemail/config/config.inc.php.

      -
    • -
    • -

      Directory /opt/iredmail/custom/roundcube/plugins/

      -

      All third-party or custom plugins should be placed under this directory. -Plugins will be linked to /opt/www/roundcubemail/plugins/ automatically +

      Custom global settings

      +
      All your custom settings should be placed in
      +__`/opt/iredmail/custom/roundcube/custom.inc.php`__, and do __NOT__
      +touch main config file `/opt/www/roundcubemail/config/config.inc.php`.
      +
      +

      Third-party or custom plugins

      +
      All third-party or custom plugins should be placed under __`/opt/iredmail/custom/roundcube/plugins/`__.
      +
      +Plugins will be linked to `/opt/www/roundcubemail/plugins/` automatically
       during iRedMail Easy deployment, but you need to create the symbol
      -link manually if you don't want to run another deployment.

      -
    • -
    • -

      Directory /opt/iredmail/custom/roundcube/skins/

      -

      All third-party or custom skins should be placed under this directory. -Skins will be linked to /opt/www/roundcubemail/skins/ automatically +link manually if you don't want to run another deployment. + +

      Custom settings for official plugins

      +
      iRedMail Easy enables 2 official plugins by default:
      +
      +- `password`: used by end users to change their own passwords.
      +- `managesieve`: used by end users to custom mail filter rules.
      +
      +If you have custom settings for plugins enabled by iRedMail Easy, please
      +put the custom settings in file
      +`/opt/iredmail/custom/roundcube/config_<plugin_name>.inc.php`.
      +
      +For example:
      +
      +- For `password` plugin: `/opt/iredmail/custom/roundcube/config_password.inc.php`
      +- For `managesieve` plugin: `/opt/iredmail/custom/roundcube/config_managesieve.inc.php`
      +
      +If you have custom settings for plugin which is not enabled by iRedMail
      +Easy, please append a line to
      +`/opt/www/roundcubemail/plugins/<plugin-name>/config.inc.php` like below:
      +
      +```
      +require_once "/opt/iredmail/custom/roundcube/config_<plugin>.inc.php";
      +```
      +
      +Then put all custom settings for this plugin to `/opt/iredmail/custom/roundcube/config_<plugin>.inc.php`.
      +
      +For example, if you have custom settings for official plugin `enigma`, you
      +should append this line to `/opt/www/roundcubemail/plugins/enigma/config.inc.php`:
      +
      +```
      +require_once "/opt/iredmail/custom/roundcube/config_enigma.inc.php";
      +```
      +
      +Then put all custom settings for plugin `enigma` to
      +`/opt/iredmail/custom/roundcube/config_enigma.inc.php`.
      +
      +This way if iRedMail Easy enables the plugin, it will successfully load
      +your own custom settings and not mess it up.
      +
      +

      Custom skins

      +
      All third-party or custom skins should be placed under __`/opt/iredmail/custom/roundcube/skins/`__.
      +
      +Skins will be linked to `/opt/www/roundcubemail/skins/` automatically
       during iRedMail Easy deployment, but you need to create the symbol link
      -manually if you don't want to run another deployment.

      -
    • -
    +manually if you don't want to run another deployment. +

    SOGo

    SOGo doesn’t support directive like include to load extra settings from multiple files, so you have to either maintain your own SOGo config