Skip to content

Commit 248bab2

Browse files
committed
updated environment variable descriptions for 1.7.0
1 parent 9f4567b commit 248bab2

File tree

4 files changed

+265
-236
lines changed

4 files changed

+265
-236
lines changed

docs/src/v1.7.0/maintain/bpe-reverse-proxy/configuration.md

Lines changed: 21 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ icon: config
1111

1212
### HTTPS_SERVER_NAME_PORT
1313
- **Required:** Yes
14-
- **Description:** External FQDN of your DSF BPE server with port, typically `443`
14+
- **Description:** FQDN of your DSF BPE server with port, typically `443`
1515
- **Example:** `my-external.fqdn:443`
1616

1717

@@ -41,34 +41,34 @@ icon: config
4141

4242
### SERVER_CONTEXT_PATH
4343
- **Required:** No
44-
- **Description:** Reverse proxy context path that delegates to the app server, `/` character at start, no `/` character at end, use `''` (empty string) to configure root as context path.
44+
- **Description:** Reverse proxy context path that delegates to the app server, `/` character at start, no `/` character at end, use `''` (empty string) to configure root as context path
4545
- **Default:** `/bpe`
4646

4747

4848
### SSL_CA_CERTIFICATE_FILE
49-
- **Required:** Yes
50-
- **Description:** Certificate chain file including all signing, intermediate and ca certificate used to validate client certificates, PEM encoded, sets the apache httpd parameter `SSLCACertificateFile`
49+
- **Required:** No
50+
- **Description:** Certificate chain file including all issuing, intermediate and root certificates used to validate client certificates, PEM encoded, sets the apache httpd parameter `SSLCACertificateFile`
5151
- **Recommendation:** Use docker secret file to configure
52-
- **Example:** `/run/secrets/ssl_ca_certificate_file.pem`
52+
- **Default:** `ca/ClientCertCaChains.pem`
5353

5454

5555
### SSL_CA_DN_REQUEST_FILE
5656
- **Required:** No
5757
- **Description:** File containing all signing certificates excepted, will be used to specify the `Acceptable client certificate CA names` send to the client, during TLS handshake, sets the apache httpd parameter `SSLCADNRequestFile`; if omitted all entries from `SSL_CA_CERTIFICATE_FILE` are used
5858
- **Recommendation:** Use docker secret file to configure
59-
- **Example:** `/run/secrets/ssl_ca_dn_request_file.pem`
59+
- **Default:** `ca/ClientCertIssuingCAs.pem`
6060

6161

6262
### SSL_CERTIFICATE_CHAIN_FILE
6363
- **Required:** No
64-
- **Description:** Certificate chain file, PEM encoded, must contain all certificates between the server certificate and the root ca certificate, sets the apache httpd parameter `SSLCertificateChainFile`; can be omitted if either no chain is needed (aka self signed server certificate) or the file specified via `SSL_CERTIFICATE_FILE` contains the certificate chain
64+
- **Description:** Certificate chain file, PEM encoded, must contain all certificates between the server certificate and the root ca certificate (excluding the root ca certificate), sets the apache httpd parameter `SSLCertificateChainFile`; can be omitted if either no chain is needed (self signed server certificate) or the file specified via `SSL_CERTIFICATE_FILE` contains the certificate chain
6565
- **Recommendation:** Use docker secret file to configure
6666
- **Example:** `/run/secrets/ssl_certificate_chain_file.pem`
6767

6868

6969
### SSL_CERTIFICATE_FILE
7070
- **Required:** Yes
71-
- **Description:** Server certificate file, PEM encoded, sets the apache httpd parameter `SSLCertificateFile`
71+
- **Description:** Server certificate file, PEM encoded, sets the apache httpd parameter `SSLCertificateFile`, may contain all certificates between the server certificate and the root ca certificate (excluding the root ca certificate). Omit `SSL_CERTIFICATE_CHAIN_FILE` if chain included
7272
- **Recommendation:** Use docker secret file to configure
7373
- **Example:** `/run/secrets/ssl_certificate_file.pem`
7474

@@ -80,8 +80,20 @@ icon: config
8080
- **Example:** `/run/secrets/ssl_certificate_key_file.pem`
8181

8282

83+
### SSL_EXPECTED_CLIENT_S_DN_C_VALUES
84+
- **Required:** No
85+
- **Description:** Expected client certificate subject DN country `C` values, must be a comma-separated list of strings in single quotation marks, e.g. `'DE', 'FR'`. If a client certificate with a not configured subject country `C` value is used, the server answers with a `403 Forbidden` status code
86+
- **Default:** `'DE'`
87+
88+
89+
### SSL_EXPECTED_CLIENT_I_DN_CN_VALUES
90+
- **Required:** No
91+
- **Description:** Expected client certificate issuer DN common-name `CN` values, must be a comma-separated list of strings in single quotation marks. If a client certificate from a not configured issuing ca common-name is used, the server answers with a `403 Forbidden` status code
92+
- **Default:** `'GEANT TLS ECC 1', 'HARICA OV TLS ECC', 'GEANT TLS RSA 1', 'HARICA OV TLS RSA', 'GEANT S/MIME ECC 1', 'HARICA S/MIME ECC', 'GEANT S/MIME RSA 1', 'HARICA S/MIME RSA', 'DFN-Verein Global Issuing CA', 'Fraunhofer User CA - G02', 'D-TRUST SSL Class 3 CA 1 2009', 'Sectigo RSA Organization Validation Secure Server CA', 'GEANT OV RSA CA 4', 'GEANT Personal CA 4', 'GEANT eScience Personal CA 4', 'Sectigo ECC Organization Validation Secure Server CA', 'GEANT OV ECC CA 4', 'GEANT Personal ECC CA 4', 'GEANT eScience Personal ECC CA 4', 'D-TRUST Limited Basic CA 1-2 2019', 'D-TRUST Limited Basic CA 1-3 2019'`
93+
94+
8395
### SSL_VERIFY_CLIENT
8496
- **Required:** No
8597
- **Description:** Modifies the apache mod_ssl config parameter `SSLVerifyClient`
8698
- **Recommendation:** Set to `optional` when using OIDC authentication
87-
- **Default:** `require`
99+
- **Default:** `require`

0 commit comments

Comments
 (0)