diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/configuration/tls.md (renamed from docs/configuration/letsencrypt.md) | 26 | ||||
| -rw-r--r-- | docs/installation_guide/docker.md | 2 |
2 files changed, 26 insertions, 2 deletions
diff --git a/docs/configuration/letsencrypt.md b/docs/configuration/tls.md index 011ab4690..79bc509eb 100644 --- a/docs/configuration/letsencrypt.md +++ b/docs/configuration/tls.md @@ -1,4 +1,12 @@ -# LetsEncrypt +# TLS + +It's possible to configure TLS support in one of two ways: +* Built-in support for Lets Encrypt / ACME compatible vendors +* Loading TLS files from disk + +It is not possible to have both methods enabled at the same time. + +Note that when using TLS files loaded from disk you are responsible for restarting the instance when the files change. They are not automatically reloaded. ## Settings @@ -39,4 +47,20 @@ letsencrypt-cert-dir: "/gotosocial/storage/certs" # Examples: ["admin@example.org"] # Default: "" letsencrypt-email-address: "" + +############################## +##### MANUAL TLS CONFIG ##### +############################## + +# String. Path to a PEM-encoded file on disk that includes the certificate chain +# and the public key +# Examples: ["/gotosocial/storage/certs/chain.pem"] +# Default: "" +tls-certificate-chain: "" + +# String. Path to a PEM-encoded file on disk containing the private key for the +# associated tls-certificate-chain +# Examples: ["/gotosocial/storage/certs/private.pem"] +# Default: "" +tls-certificate-key: "" ``` diff --git a/docs/installation_guide/docker.md b/docs/installation_guide/docker.md index e752ac750..140a1fefc 100644 --- a/docs/installation_guide/docker.md +++ b/docs/installation_guide/docker.md @@ -92,7 +92,7 @@ For example, let's say you created the `~/gotosocial/data` directory for a user #### LetsEncrypt (optional) -If you want to use [LetsEncrypt](../configuration/letsencrypt.md) for ssl certificates (https), you should also: +If you want to use [LetsEncrypt](../configuration/tls.md) for ssl certificates (https), you should also: 1. Change the value of `GTS_LETSENCRYPT_ENABLED` to `"true"`. 2. Remove the `#` before `- "80:80"` in the `ports` section. |