Skip to content

Commit 1f941c0

Browse files
paketb0teKludex
andauthored
Improve HTTPS section in the documentation (#2030)
Co-authored-by: Marcelo Trylesinski <[email protected]>
1 parent bcbf441 commit 1f941c0

File tree

1 file changed

+12
-8
lines changed

1 file changed

+12
-8
lines changed

docs/settings.md

+12-8
Original file line numberDiff line numberDiff line change
@@ -98,13 +98,17 @@ connecting IPs in the `forwarded-allow-ips` configuration.
9898

9999
## HTTPS
100100

101-
* `--ssl-keyfile <path>` - SSL key file
102-
* `--ssl-keyfile-password <str>` - Password to decrypt the ssl key
103-
* `--ssl-certfile <path>` - SSL certificate file
104-
* `--ssl-version <int>` - SSL version to use (see stdlib ssl module's)
105-
* `--ssl-cert-reqs <int>` - Whether client certificate is required (see stdlib ssl module's)
106-
* `--ssl-ca-certs <str>` - CA certificates file
107-
* `--ssl-ciphers <str>` - Ciphers to use (see stdlib ssl module's)
101+
The [SSL context](https://docs.python.org/3/library/ssl.html#ssl.SSLContext) can be configured with the following options:
102+
103+
* `--ssl-keyfile <path>` - The SSL key file.
104+
* `--ssl-keyfile-password <str>` - The password to decrypt the ssl key.
105+
* `--ssl-certfile <path>` - The SSL certificate file.
106+
* `--ssl-version <int>` - The SSL version to use.
107+
* `--ssl-cert-reqs <int>` - Whether client certificate is required.
108+
* `--ssl-ca-certs <str>` - The CA certificates file.
109+
* `--ssl-ciphers <str>` - The ciphers to use.
110+
111+
To understand more about the SSL context options, please refer to the [Python documentation](https://docs.python.org/3/library/ssl.html).
108112

109113
## Resource Limits
110114

@@ -115,4 +119,4 @@ connecting IPs in the `forwarded-allow-ips` configuration.
115119
## Timeouts
116120

117121
* `--timeout-keep-alive <int>` - Close Keep-Alive connections if no new data is received within this timeout. **Default:** *5*.
118-
* `--timeout-graceful-shutdown <int>` - Maximum number of seconds to wait for graceful shutdown. After this timeout, the server will start terminating requests.
122+
* `--timeout-graceful-shutdown <int>` - Maximum number of seconds to wait for graceful shutdown. After this timeout, the server will start terminating requests.

0 commit comments

Comments
 (0)