Skip to content

Commit 898a37f

Browse files
hhundhhund
committed
styling of config parameter references
1 parent 71c6697 commit 898a37f

File tree

2 files changed

+11
-11
lines changed

2 files changed

+11
-11
lines changed

‎docs/src/operations/v2.0.0-RC1/bpe-reverse-proxy/configuration.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ icon: config
4747

4848
### SSL_CA_CERTIFICATE_FILE
4949
- **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`; not used by default, overrides `SSL_CA_CERTIFICATE_PATH` if not empty
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`; not used by default, overrides *SSL_CA_CERTIFICATE_PATH* if not empty
5151

5252

5353
### SSL_CA_CERTIFICATE_PATH
@@ -59,26 +59,26 @@ icon: config
5959

6060
### SSL_CA_DN_REQUEST_FILE
6161
- **Required:** No
62-
- **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; not used by default, overrides `SSL_CA_DN_REQUEST_PATH` if not empty
62+
- **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; not used by default, overrides *SSL_CA_DN_REQUEST_PATH* if not empty
6363

6464

6565
### SSL_CA_DN_REQUEST_PATH
6666
- **Required:** No
67-
- **Description:** Folder with trusted client certificate issuing CAs, modifies the "Acceptable client certificate CA names" send to the client, uses all from `SSL_CA_CERTIFICATE_FILE` or `SSL_CA_CERTIFICATE_PATH` if not set or empty
67+
- **Description:** Folder with trusted client certificate issuing CAs, modifies the "Acceptable client certificate CA names" send to the client, uses all from *SSL_CA_CERTIFICATE_FILE* or *SSL_CA_CERTIFICATE_PATH* if not set or empty
6868
- **Recommendation:** Override default folder content via bind mount or add *.crt files to default folder via bind mount
6969
- **Default:** `ca/client_issuing_cas`
7070

7171

7272
### SSL_CERTIFICATE_CHAIN_FILE
7373
- **Required:** No
74-
- **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
74+
- **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
7575
- **Recommendation:** Use docker secret file to configure
7676
- **Example:** `/run/secrets/ssl_certificate_chain_file.pem`
7777

7878

7979
### SSL_CERTIFICATE_FILE
8080
- **Required:** Yes
81-
- **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
81+
- **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
8282
- **Recommendation:** Use docker secret file to configure
8383
- **Example:** `/run/secrets/ssl_certificate_file.pem`
8484

‎docs/src/operations/v2.0.0-RC1/fhir-reverse-proxy/configuration.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ icon: config
4747

4848
### SSL_CA_CERTIFICATE_FILE
4949
- **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`; not used by default, overrides `SSL_CA_CERTIFICATE_PATH` if not empty
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`; not used by default, overrides *SSL_CA_CERTIFICATE_PATH* if not empty
5151

5252

5353
### SSL_CA_CERTIFICATE_PATH
@@ -59,33 +59,33 @@ icon: config
5959

6060
### SSL_CA_DN_REQUEST_FILE
6161
- **Required:** No
62-
- **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; not used by default, overrides `SSL_CA_DN_REQUEST_PATH` if not empty
62+
- **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; not used by default, overrides *SSL_CA_DN_REQUEST_PATH* if not empty
6363

6464

6565
### SSL_CA_DN_REQUEST_PATH
6666
- **Required:** No
67-
- **Description:** Folder with trusted client certificate issuing CAs, modifies the "Acceptable client certificate CA names" send to the client, uses all from `SSL_CA_CERTIFICATE_FILE` or `SSL_CA_CERTIFICATE_PATH` if not set or empty
67+
- **Description:** Folder with trusted client certificate issuing CAs, modifies the "Acceptable client certificate CA names" send to the client, uses all from *SSL_CA_CERTIFICATE_FILE* or *SSL_CA_CERTIFICATE_PATH* if not set or empty
6868
- **Recommendation:** Override default folder content via bind mount or add *.crt files to default folder via bind mount
6969
- **Default:** `ca/client_issuing_cas`
7070

7171

7272
### SSL_CERTIFICATE_CHAIN_FILE
7373
- **Required:** No
74-
- **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
74+
- **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
7575
- **Recommendation:** Use docker secret file to configure
7676
- **Example:** `/run/secrets/ssl_certificate_chain_file.pem`
7777

7878

7979
### SSL_CERTIFICATE_CHAIN_FILE
8080
- **Required:** No
81-
- **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
81+
- **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
8282
- **Recommendation:** Use docker secret file to configure
8383
- **Example:** `/run/secrets/ssl_certificate_chain_file.pem`
8484

8585

8686
### SSL_CERTIFICATE_FILE
8787
- **Required:** Yes
88-
- **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
88+
- **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
8989
- **Recommendation:** Use docker secret file to configure
9090
- **Example:** `/run/secrets/ssl_certificate_file.pem`
9191

0 commit comments

Comments
 (0)