Skip to content

Commit e4ef755

Browse files
committed
3.0.0pre
1 parent 0729be9 commit e4ef755

File tree

3 files changed

+168
-104
lines changed

3 files changed

+168
-104
lines changed

README.md

Lines changed: 32 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -142,29 +142,33 @@ By Default this image is ready to run out of the box, without having to alter an
142142

143143
#### Configuration Variables
144144

145-
| Parameter | Description | Default | `_FILE` |
146-
| -------------------------------------------- | ------------------------------------------------------------------------------ | ------------------- | ------- |
147-
| `CONFIG_CHECK_INTERVAL` | Interval for config checks in seconds | `1` | |
148-
| `CONFIG_INSTANCE_PATH` | Instance config path | `/config/` | |
149-
| `CONFIG_INSTANCE_FILE` | Instance config file | `instance.cfg` | |
150-
| `CONFIG_GLOBAL_TYPE` | Global config type `FILE` or `REST` | `FILE` | |
151-
| `CONFIG_GLOBAL_CONFIG_TIMEOUT` | Global config timeout in seconds | `10` | |
152-
| `CONFIG_GLOBAL_FILE_PATH` | Global file path | `${DATA_PATH}/conf` | |
153-
| `CONFIG_GLOBAL_FILE_PRETTY_PRINT` | Pretty print config file | `TRUE` | |
154-
| `CONFIG_GLOBAL_REST_HOST` | Hostname of Portal REST Server eg `https://sso.example.com/index.psgi/config/` | | x |
155-
| `CONFIG_GLOBAL_REST_USER` | Username to fetch Configuration Information | | x |
156-
| `CONFIG_GLOBAL_REST_PASS` | Password to fetch Configuration Information | | x |
157-
| `CONFIG_GLOBAL_CACHE_TYPE` | Global cache type `FILE` `NONE` | `FILE` | |
158-
| `CONFIG_GLOBAL_CACHE_FILE_PATH` | Global cache file path | `/cache/` | |
159-
| `CONFIG_GLOBAL_CACHE_FILE_NAMESPACE` | Global cache file namespace | `config` | |
160-
| `CONFIG_GLOBAL_CACHE_FILE_DEPTH` | Global cache file depth | `0` | |
161-
| `CONFIG_GLOBAL_CACHE_FILE_DIR_MASK` | Global cache file dir mask | `007` | |
162-
| `CONFIG_GLOBAL_CACHE_FILE_EXPIRY` | Global cache file expiry | `600` | |
163-
| `CONFIG_GLOBAL_SCHEDULE_PURGE_CENTRAL_CACHE` | Cron expression to purge central cache (or `FALSE` to disable) | `*/10 * * * *` | |
164-
| `CONFIG_GLOBAL_SCHEDULE_ROTATE_OIDC_KEYS` | Cron expresstion to rotate OIDC keys (or `FALSE` to disable) | `5 5 * * 6` | |
165-
| `CONFIG_GLOBAL_SCHEDULE_PURGE_LOCAL_CACHE` | Cron expression to purge local cache (or `FALSE` to disable) | `1 * * * *` | |
166-
| `CONFIG_ENABLE_CROSS_DOMAIN` | (instance) Enable Cross Domain Access (CDA) `TRUE`/`FALSE` | | |
167-
| `CONFIG_USE_SAFE_JAIL` | (instance) Use safe jail | `TRUE` | |
145+
| Parameter | Description | Default | `_FILE` |
146+
| -------------------------------------------- | ------------------------------------------------------------------------------ | ------------------------ | ------- |
147+
| `CONFIG_CHECK_INTERVAL` | Interval for config checks in seconds | `1` | |
148+
| `CONFIG_INSTANCE_PATH` | Instance config path | `/config/` | |
149+
| `CONFIG_INSTANCE_FILE` | Instance config file | `instance.cfg` | |
150+
| `CONFIG_GLOBAL_TYPE` | Global config type `FILE` or `REST` | `FILE` | |
151+
| `CONFIG_GLOBAL_CONFIG_TIMEOUT` | Global config timeout in seconds | `10` | |
152+
| `CONFIG_GLOBAL_FILE_PATH` | Global file path | `${DATA_PATH}/conf` | |
153+
| `CONFIG_GLOBAL_FILE_PRETTY_PRINT` | Pretty print config file | `TRUE` | |
154+
| `CONFIG_GLOBAL_ENABLE_SECRETS` | Enable Secrets / Overlay mode | `TRUE` | |
155+
| `CONFIG_GLOBAL_SECRETS_PATH` | Path name to store file per parameter (filename == keyname) | `/var/run/secrets/llng/` | x |
156+
| `CONFIG_GLOBAL_SECRETS_READONLY` | Allow configuration to write to secrets parameters | `FALSE` | |
157+
| `CONFIG_GLOBAL_SECRETS_REAL_TYPE` | The real configuration backend used to support secrets/overlay | `${CONFIG_GLOBAL_TYPE}` | |
158+
| `CONFIG_GLOBAL_REST_HOST` | Hostname of Portal REST Server eg `https://sso.example.com/index.psgi/config/` | | x |
159+
| `CONFIG_GLOBAL_REST_USER` | Username to fetch Configuration Information | | x |
160+
| `CONFIG_GLOBAL_REST_PASS` | Password to fetch Configuration Information | | x |
161+
| `CONFIG_GLOBAL_CACHE_TYPE` | Global cache type `FILE` `NONE` | `FILE` | |
162+
| `CONFIG_GLOBAL_CACHE_FILE_PATH` | Global cache file path | `/cache/` | |
163+
| `CONFIG_GLOBAL_CACHE_FILE_NAMESPACE` | Global cache file namespace | `config` | |
164+
| `CONFIG_GLOBAL_CACHE_FILE_DEPTH` | Global cache file depth | `0` | |
165+
| `CONFIG_GLOBAL_CACHE_FILE_DIR_MASK` | Global cache file dir mask | `007` | |
166+
| `CONFIG_GLOBAL_CACHE_FILE_EXPIRY` | Global cache file expiry | `600` | |
167+
| `CONFIG_GLOBAL_SCHEDULE_PURGE_CENTRAL_CACHE` | Cron expression to purge central cache (or `FALSE` to disable) | `*/10 * * * *` | |
168+
| `CONFIG_GLOBAL_SCHEDULE_ROTATE_OIDC_KEYS` | Cron expresstion to rotate OIDC keys (or `FALSE` to disable) | `5 5 * * 6` | |
169+
| `CONFIG_GLOBAL_SCHEDULE_PURGE_LOCAL_CACHE` | Cron expression to purge local cache (or `FALSE` to disable) | `1 * * * *` | |
170+
| `CONFIG_ENABLE_CROSS_DOMAIN` | (instance) Enable Cross Domain Access (CDA) `TRUE`/`FALSE` | | |
171+
| `CONFIG_USE_SAFE_JAIL` | (instance) Use safe jail | `TRUE` | |
168172

169173
#### Socket & Networking Variables
170174

@@ -259,7 +263,7 @@ For usage with `MODE=MANAGER`
259263
| `MANAGER_CUSTOM_PORTAL_URL` | Custom Portal URL in Manager header | | x |
260264
| `MANAGER_STATIC_PREFIX` | Manager static prefix | `/static` | |
261265
| `MANAGER_CSS_PATH` | Manager CSS path | `/usr/share/lemonldap-ng/manager/static/css` | |
262-
| `MANAGER_CUSTOM_CSS_FILE` | Custom Manager CSS path+file to use | | x |
266+
| `MANAGER_CUSTOM_CSS_FILE` | Custom Manager CSS path+file to use | | |
263267
| `MANAGER_LANGUAGE_PATH` | Manager Language path | `/usr/share/lemonldap-ng/manager/static/languages` | |
264268
| `MANAGER_LOGOS_PATH` | Manager Logos path | `/usr/share/lemonldap-ng/manager/static/logos` | |
265269
| `MANAGER_TEMPLATE_PATH` | Manager Template path | `/usr/share/lemonldap-ng/manager/templates` | |
@@ -310,9 +314,13 @@ For usage with `MODE=PORTAL`
310314
| `PORTAL_SESSIONS_ACTIVE_FILE_PATH` | Override Instance or Global Config Portal active session path | `${INSTANCE_SESSIONS_ACTIVE_FILE_PATH}` | |
311315
| `PORTAL_SESSIONS_PERSISTENT_TYPE` | Override Instance or Global Config Portal persistent session type `FILE` or `NONE` | `NONE` | |
312316
| `PORTAL_SESSIONS_PERSISTENT_FILE_PATH` | Override Instance or Global Config Portal persistent session path | `${INSTANCE_SESSIONS_PERSISTENT_FILE_PATH}` | |
317+
| `PORTAL_CUSTOM_CSS_FILE` | Custom Portal CSS path+file to use | | |
318+
| `PORTAL_CUSTOM_JS_FILE` | Custom Portal JS path+file to use | | |
313319
| `PORTAL_ENABLE_CAPTCHA` | Enable Captcha Plugin `TRUE`/`FALSE` | | |
314320
| `PORTAL_CAPTCHA_PATH` | Path for storing captchas | `${DATA_PATH}/captcha` | |
315321
| `PORTAL_ENABLE_NOTIFICATIONS` | Enable notifications in portal | `TRUE` | |
322+
| `PORTAL_GEOIP_PATH` | Path for GeoIP Database if used | | |
323+
| `PORTAL_SKIN` | Override Portal Skin Name | | |
316324
| `PORTAL_NOTIFICATIONS_TYPE` | Portal notifications type | `FILE` | |
317325
| `PORTAL_NOTIFICATIONS_TYPE_FILE_PATH` | Portal notifications file path | `${DATA_PATH}/notifications` | |
318326
| `PORTAL_NOTIFICATIONS_TYPE_FILE_SEPERATOR` | Portal notifications file separator | `_` | |

rootfs/container/defaults/20-llng

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
# SPDX-License-Identifier: MIT
44

55
DATA_PATH=${DATA_PATH:-"/data/"}
6+
CONFIG_GLOBAL_TYPE=${CONFIG_GLOBAL_TYPE:-"FILE"}
67
##
78
#HANDLER_CACHE_TYPE=${HANDLER_CACHE_TYPE:-"FILE"} ## IF THERE ARE PROLBEMS MAKE THIS DEFAULT FILE
89
CONFIG_CHECK_INTERVAL=${CONFIG_CHECK_INTERVAL:-"1"}
@@ -13,12 +14,17 @@ CONFIG_GLOBAL_CACHE_FILE_NAMESPACE=${CONFIG_GLOBAL_CACHE_FILE_NAMESPACE:-"config
1314
CONFIG_GLOBAL_CACHE_FILE_PATH=${CONFIG_GLOBAL_CACHE_FILE_PATH:-"/cache/"}
1415
CONFIG_GLOBAL_CACHE_TYPE=${CONFIG_GLOBAL_CACHE_TYPE:-"FILE"}
1516
CONFIG_GLOBAL_CONFIG_TIMEOUT=${CONFIG_GLOBAL_CONFIG_TIMEOUT:-"10"}
17+
1618
CONFIG_GLOBAL_FILE_PATH=${CONFIG_GLOBAL_FILE_PATH:-"${DATA_PATH%/}/conf"}
1719
CONFIG_GLOBAL_FILE_PRETTY_PRINT=${CONFIG_GLOBAL_FILE_PRETTY_PRINT:-"TRUE"}
20+
CONFIG_GLOBAL_ENABLE_SECRETS=${CONFIG_GLOBAL_ENABLE_SECRETS:-"TRUE"}
21+
CONFIG_GLOBAL_SECRETS_PATH=${CONFIG_GLOBAL_SECRETS_PATH:-"/var/run/secrets/llng/"}
22+
CONFIG_GLOBAL_SECRETS_READONLY=${CONFIG_GLOBAL_SECRETS_READONLY:-"TRUE"}
23+
CONFIG_GLOBAL_SECRETS_REAL_TYPE=${CONFIG_GLOBAL_SECRETS_REAL_TYPE:-"${CONFIG_GLOBAL_TYPE}"}
1824
CONFIG_GLOBAL_SCHEDULE_PURGE_CENTRAL_CACHE=${CONFIG_GLOBAL_SCHEDULE_PURGE_CENTRAL_CACHE:-"*/10 * * * *"}
1925
CONFIG_GLOBAL_SCHEDULE_PURGE_LOCAL_CACHE=${CONFIG_GLOBAL_SCHEDULE_PURGE_LOCAL_CACHE:-"1 * * * *"}
2026
CONFIG_GLOBAL_SCHEDULE_ROTATE_OIDC_KEYS=${CONFIG_GLOBAL_SCHEDULE_ROTATE_OIDC_KEYS:-"5 5 * * 6"}
21-
CONFIG_GLOBAL_TYPE=${CONFIG_GLOBAL_TYPE:-"FILE"}
27+
2228
CONFIG_INSTANCE_FILE=${CONFIG_INSTANCE_FILE:-"instance.cfg"}
2329
CONFIG_INSTANCE_PATH=${CONFIG_INSTANCE_PATH:-"/config/"}
2430
CONFIG_USE_SAFE_JAIL=${CONFIG_USE_SAFE_JAIL:-"TRUE"}

0 commit comments

Comments
 (0)