From 8902f73e0e39be85c70b21a399f7682c5b4a1578 Mon Sep 17 00:00:00 2001 From: Felix Bartels <1257835+fbartels@users.noreply.github.com> Date: Tue, 15 Sep 2020 08:50:09 +0200 Subject: [PATCH] copy config settings to webapp readme (#442) Signed-off-by: Felix Bartels --- php/README.md | 2 +- webapp/README.md | 34 +++++++++++++++++++++++++++++++++- 2 files changed, 34 insertions(+), 2 deletions(-) diff --git a/php/README.md b/php/README.md index 61c0d5f..09d659b 100644 --- a/php/README.md +++ b/php/README.md @@ -34,4 +34,4 @@ General prefix | | | Name of the configuration option in the configuration file | Value of the configuration option -``` \ No newline at end of file +``` diff --git a/webapp/README.md b/webapp/README.md index 34512f1..6e8b9d1 100644 --- a/webapp/README.md +++ b/webapp/README.md @@ -2,4 +2,36 @@ [![](https://images.microbadger.com/badges/image/zokradonh/kopano_webapp.svg)](https://microbadger.com/images/zokradonh/kopano_webapp "Microbadger size/labels") [![](https://images.microbadger.com/badges/version/zokradonh/kopano_webapp.svg)](https://microbadger.com/images/zokradonh/kopano_webapp "Microbadger version") -Image for Kopano WebApp and its plugins. Please check in the `kopano_php` folder for configuration instructions. \ No newline at end of file +Image for Kopano WebApp and its plugins. Please check in the `kopano_php` folder for configuration instructions. + +## Configuration through environment variables + +Any additional configuration should be done through environment variables and not done in the actual container. The images working with configuration files (e.g. `kopano_core`, `kopano_webapp`, `kopano_meet`) have a mechanism built in to translate env variables into configuration files. For services that can directly work with env variables (e.g. `kopano_konnect`, ´kopano_kwmserver´) these can be specified directly. Please check the individual `README.md` files for further instructions. + +Examples of env variables: + +```bash +KCCONF_WEBAPP_CLIENT_TIMEOUT=3600 +^ ^ ^ ^ +| | | | +General prefix| | + | | | + Special value to signal the change should go into config.php belonging to WebApp + | | + Name of the configuration option in the configuration file + | + Value of the configuration option + +KCCONF_WEBAPPPLUGIN_MDM_PLUGIN_MDM_USER_DEFAULT_ENABLE_MDM=true +^ ^ ^ ^ ^ +| | | | | +General prefix | | | + | | | | + Special value to signal the change should go into config-$identifier.php (located in /etc/kopano/webapp) + | | | + Identifier for the configuration file (config-$identifier.php) + | | + Name of the configuration option in the configuration file + | + Value of the configuration option +```