From cfeb8cade7891807b492b982d593671c0420e6a7 Mon Sep 17 00:00:00 2001 From: Alexey Pustovalov Date: Mon, 29 May 2023 13:06:25 +0900 Subject: [PATCH] Added more detailed description for SSO variables --- Dockerfiles/web-apache-mysql/README.md | 22 ++++++++++++++++++++++ Dockerfiles/web-apache-pgsql/README.md | 22 ++++++++++++++++++++++ Dockerfiles/web-nginx-mysql/README.md | 22 ++++++++++++++++++++++ Dockerfiles/web-nginx-pgsql/README.md | 22 ++++++++++++++++++++++ 4 files changed, 88 insertions(+) diff --git a/Dockerfiles/web-apache-mysql/README.md b/Dockerfiles/web-apache-mysql/README.md index 080917b2d..cb623b29b 100644 --- a/Dockerfiles/web-apache-mysql/README.md +++ b/Dockerfiles/web-apache-mysql/README.md @@ -196,10 +196,32 @@ The variable allows to activate host verification. Available since 5.0.0. The variable allows to specify a custom list of valid ciphers. The format of the cipher list must conform to the OpenSSL standard. Available since 5.0.0. +### `ZBX_SSO_SP_KEY` + +The variable allows to specify a custom file path to the Serivce Provider (SP) private key file. + +### `ZBX_SSO_SP_CERT` + +The variable allows to specify a custom file path to the Serivce Provider (SP) cert file. + +### `ZBX_SSO_IDP_CERT` + +The variable allows to specify a custom file path to the SAML Certificate provided by the Identity Provider (ID) file. + ## `ZBX_SSO_SETTINGS` The variable allows to specify custom SSO settings in JSON format. Available since 5.0.0. +Example of YAML Mapping to Sequences + +``` +.... + environment: + ZBX_SSO_SETTINGS: "{'baseurl': 'https://zabbix-docker.mydomain.com', 'use_proxy_headers': true, 'strict': false}" + .... +.... +``` + ### Other variables Additionally the image allows to specify many other environment variables listed below: diff --git a/Dockerfiles/web-apache-pgsql/README.md b/Dockerfiles/web-apache-pgsql/README.md index ea6f7bdb1..7e608e9a4 100644 --- a/Dockerfiles/web-apache-pgsql/README.md +++ b/Dockerfiles/web-apache-pgsql/README.md @@ -196,10 +196,32 @@ The variable allows to specify the full path to a valid TLS certificate authorit The variable allows to activate host verification. Available since 5.0.0. +### `ZBX_SSO_SP_KEY` + +The variable allows to specify a custom file path to the Serivce Provider (SP) private key file. + +### `ZBX_SSO_SP_CERT` + +The variable allows to specify a custom file path to the Serivce Provider (SP) cert file. + +### `ZBX_SSO_IDP_CERT` + +The variable allows to specify a custom file path to the SAML Certificate provided by the Identity Provider (ID) file. + ## `ZBX_SSO_SETTINGS` The variable allows to specify custom SSO settings in JSON format. Available since 5.0.0. +Example of YAML Mapping to Sequences + +``` +.... + environment: + ZBX_SSO_SETTINGS: "{'baseurl': 'https://zabbix-docker.mydomain.com', 'use_proxy_headers': true, 'strict': false}" + .... +.... +``` + ### Other variables Additionally the image allows to specify many other environment variables listed below: diff --git a/Dockerfiles/web-nginx-mysql/README.md b/Dockerfiles/web-nginx-mysql/README.md index df2a6a684..5c586a271 100644 --- a/Dockerfiles/web-nginx-mysql/README.md +++ b/Dockerfiles/web-nginx-mysql/README.md @@ -197,10 +197,32 @@ The variable allows to activate host verification. Available since 5.0.0. The variable allows to specify a custom list of valid ciphers. The format of the cipher list must conform to the OpenSSL standard. Available since 5.0.0. +### `ZBX_SSO_SP_KEY` + +The variable allows to specify a custom file path to the Serivce Provider (SP) private key file. + +### `ZBX_SSO_SP_CERT` + +The variable allows to specify a custom file path to the Serivce Provider (SP) cert file. + +### `ZBX_SSO_IDP_CERT` + +The variable allows to specify a custom file path to the SAML Certificate provided by the Identity Provider (ID) file. + ## `ZBX_SSO_SETTINGS` The variable allows to specify custom SSO settings in JSON format. Available since 5.0.0. +Example of YAML Mapping to Sequences + +``` +.... + environment: + ZBX_SSO_SETTINGS: "{'baseurl': 'https://zabbix-docker.mydomain.com', 'use_proxy_headers': true, 'strict': false}" + .... +.... +``` + ### Other variables Additionally the image allows to specify many other environment variables listed below: diff --git a/Dockerfiles/web-nginx-pgsql/README.md b/Dockerfiles/web-nginx-pgsql/README.md index e0338594c..a5f698d3e 100644 --- a/Dockerfiles/web-nginx-pgsql/README.md +++ b/Dockerfiles/web-nginx-pgsql/README.md @@ -196,10 +196,32 @@ The variable allows to specify the full path to a valid TLS certificate authorit The variable allows to activate host verification. Available since 5.0.0. +### `ZBX_SSO_SP_KEY` + +The variable allows to specify a custom file path to the Serivce Provider (SP) private key file. + +### `ZBX_SSO_SP_CERT` + +The variable allows to specify a custom file path to the Serivce Provider (SP) cert file. + +### `ZBX_SSO_IDP_CERT` + +The variable allows to specify a custom file path to the SAML Certificate provided by the Identity Provider (ID) file. + ## `ZBX_SSO_SETTINGS` The variable allows to specify custom SSO settings in JSON format. Available since 5.0.0. +Example of YAML Mapping to Sequences + +``` +.... + environment: + ZBX_SSO_SETTINGS: "{'baseurl': 'https://zabbix-docker.mydomain.com', 'use_proxy_headers': true, 'strict': false}" + .... +.... +``` + ### Other variables Additionally the image allows to specify many other environment variables listed below: