diff --git a/docs/third_party/roundcube/third_party-roundcube.en.md b/docs/third_party/roundcube/third_party-roundcube.en.md index 3e05572ef..409abf046 100644 --- a/docs/third_party/roundcube/third_party-roundcube.en.md +++ b/docs/third_party/roundcube/third_party-roundcube.en.md @@ -403,15 +403,15 @@ EOCONFIG ### Integrate CardDAV addressbooks in Roundcube === "Integrated" - Install the latest v5 version (the config below is compatible with v5 releases) using composer. - Answer `Y` when asked if you want to activate the plugin. +Install the latest v5 version (the config below is compatible with v5 releases) using composer. +Answer `Y` when asked if you want to activate the plugin. ```bash docker exec -it -w /web/rc $(docker ps -f name=php-fpm-mailcow -q) composer require --update-no-dev -o "roundcube/carddav:~5" ``` === "Standalone" - Install the latest version of CardDAV (config based on v5 releases) by adding `carddav` to `ROUNDCUBEMAIL_PLUGINS`: +Install the latest version of CardDAV (config based on v5 releases) by adding `carddav` to `ROUNDCUBEMAIL_PLUGINS`: ```yaml ROUNDCUBEMAIL_PLUGINS: archive, managesieve, acl, markasjunk, zipdownload, carddav @@ -517,16 +517,16 @@ $MAILCOW_APPS = [ First, install plugin [dovecot_impersonate](https://github.com/corbosman/dovecot_impersonate/) and add Roundcube as an app (see above). === "Integrated" - ```bash +`bash docker exec -it -w /web/rc/plugins $(docker ps -f name=php-fpm-mailcow -q) git clone https://github.com/corbosman/dovecot_impersonate.git - ``` + ` === "Standalone" - ```bash +`bash docker exec -it -w /var/www/html/plugins $(docker ps -f name=roundcube -q) git clone https://github.com/corbosman/dovecot_impersonate.git - ``` + ` -Open `data/web/rc/config/config.inc.php` and enable the dovecot_impersonate plugin by adding it to the `$config['plugins']` array or by adding it to `ROUNDCUBEMAIL_PLUGINS`. +Open `data/web/rc/config/config.inc.php` and enable the dovecot_impersonate plugin by adding it to the `$config['plugins']` array or by adding it to `ROUNDCUBEMAIL_PLUGINS`. for example: === "Integrated" @@ -599,6 +599,110 @@ Copy the contents of the following files from this [Snippet](https://gitlab.com/ - `data/web/inc/lib/RoundcubeAutoLogin.php` - `data/web/rc-auth.php` +### Let users authenticate with mailcow (oauth) + +First, we have to define some placeholders: + +- roundcube.example.com + (can also be hosted on the `/rc` subpath on you mailcow host) +- mail.example.com (your mailcow host) + +In mailcow UI under `Admin > Oauth2 Apps`, create a new oauth2 App. +Set the redirect uri to `https://roundcube.example.com/index.php/login/oauth`. +Take note of the Client ID and SECRET. + +Create a Roundcube config file under `./data/rc/config/config.oauth.inc.php`. +`./data/rc/config/config.oauth.inc.php` + +```php + 1.6.X (in the futur: 1.7.X) @@ -667,15 +771,15 @@ Finally, restart mailcow ### Upgrade composer plugins === "Integrated" - To upgrade roundcube plugins installed using composer and dependencies (e.g. RCMCardDAV plugin), you can simply run - composer in the container: +To upgrade roundcube plugins installed using composer and dependencies (e.g. RCMCardDAV plugin), you can simply run +composer in the container: ```bash docker exec -it -w /web/rc $(docker ps -f name=php-fpm-mailcow -q) composer update --no-dev -o ``` === "Standalone" - To update composer plugins increase the version number at the end of a import: +To update composer plugins increase the version number at the end of a import: ```yaml ROUNDCUBEMAIL_COMPOSER_PLUGINS: "roundcube/carddav:~4" # increase to v5 @@ -721,7 +825,7 @@ place else instead of deleting it. docker-compose down ``` - Then you can safely delete `data/web/rc` / `data/rc/`. + Then you can safely delete `data/web/rc` / `data/rc/`. ### Remove the database @@ -872,6 +976,3 @@ the roundcube tables from the mailcow database using the following command: ```bash docker exec -it $(docker ps -f name=mysql-mailcow -q) mysql -uroot -p${DBROOT} -sN mailcow -e "SET SESSION foreign_key_checks = 0; DROP TABLE IF EXISTS $(echo $RCTABLES | sed -e 's/ \+/,/g');" ``` - - -