|
| 1 | +--- |
| 2 | +title: Configuration Parameters |
| 3 | +icon: config |
| 4 | +--- |
| 5 | + |
| 6 | +### APP_SERVER_IP |
| 7 | +- **Required:** Yes |
| 8 | +- **Description:** Hostname or IP-Address of the DSF BPE server application container, the reverse proxy target |
| 9 | +- **Example:** `app`, `172.28.1.3` |
| 10 | + |
| 11 | + |
| 12 | +### HTTPS_SERVER_NAME_PORT |
| 13 | +- **Required:** Yes |
| 14 | +- **Description:** FQDN of your DSF BPE server with port, typically `443` |
| 15 | +- **Example:** `my-external.fqdn:443` |
| 16 | + |
| 17 | + |
| 18 | +### PROXY_PASS_CONNECTION_TIMEOUT_HTTP |
| 19 | +- **Required:** No |
| 20 | +- **Description:** Connection timeout (seconds) for reverse proxy to app server http connection, time the proxy waits for a connection to be established |
| 21 | +- **Default:** `30` seconds |
| 22 | + |
| 23 | + |
| 24 | +### PROXY_PASS_CONNECTION_TIMEOUT_WS |
| 25 | +- **Required:** No |
| 26 | +- **Description:** Connection timeout (seconds) for reverse proxy to app server ws connection, time the proxy waits for a connection to be established |
| 27 | +- **Default:** `30` seconds |
| 28 | + |
| 29 | + |
| 30 | +### PROXY_PASS_TIMEOUT_HTTP |
| 31 | +- **Required:** No |
| 32 | +- **Description:** Timeout (seconds) for reverse proxy to app server http connection, time the proxy waits for a reply |
| 33 | +- **Default:** `60` seconds |
| 34 | + |
| 35 | + |
| 36 | +### PROXY_PASS_TIMEOUT_WS |
| 37 | +- **Required:** No |
| 38 | +- **Description:** Timeout (seconds) for reverse proxy to app server ws connection, time the proxy waits for a reply |
| 39 | +- **Default:** `60` seconds |
| 40 | + |
| 41 | + |
| 42 | +### SERVER_CONTEXT_PATH |
| 43 | +- **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 |
| 45 | +- **Default:** `/bpe` |
| 46 | + |
| 47 | + |
| 48 | +### SSL_CA_CERTIFICATE_FILE |
| 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` |
| 51 | +- **Recommendation:** Use docker secret file to configure |
| 52 | +- **Default:** `ca/client_cert_ca_chains.pem` |
| 53 | + |
| 54 | + |
| 55 | +### SSL_CA_DN_REQUEST_FILE |
| 56 | +- **Required:** No |
| 57 | +- **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 |
| 58 | +- **Recommendation:** Use docker secret file to configure |
| 59 | +- **Default:** `ca/client_cert_issuing_cas.pem` |
| 60 | + |
| 61 | + |
| 62 | +### SSL_CERTIFICATE_CHAIN_FILE |
| 63 | +- **Required:** No |
| 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 |
| 65 | +- **Recommendation:** Use docker secret file to configure |
| 66 | +- **Example:** `/run/secrets/ssl_certificate_chain_file.pem` |
| 67 | + |
| 68 | + |
| 69 | +### SSL_CERTIFICATE_FILE |
| 70 | +- **Required:** Yes |
| 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 |
| 72 | +- **Recommendation:** Use docker secret file to configure |
| 73 | +- **Example:** `/run/secrets/ssl_certificate_file.pem` |
| 74 | + |
| 75 | + |
| 76 | +### SSL_CERTIFICATE_KEY_FILE |
| 77 | +- **Required:** Yes |
| 78 | +- **Description:** Server certificate private key file, PEM encoded, unencrypted, sets the apache httpd parameter `SSLCertificateKeyFile` |
| 79 | +- **Recommendation:** Use docker secret file to configure |
| 80 | +- **Example:** `/run/secrets/ssl_certificate_key_file.pem` |
| 81 | + |
| 82 | + |
| 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 | + |
| 95 | +### SSL_VERIFY_CLIENT |
| 96 | +- **Required:** No |
| 97 | +- **Description:** Modifies the apache mod_ssl config parameter `SSLVerifyClient` |
| 98 | +- **Recommendation:** Set to `optional` when using OIDC authentication |
| 99 | +- **Default:** `require` |
0 commit comments