diff options
author | 2021-12-07 13:31:39 +0100 | |
---|---|---|
committer | 2021-12-07 13:31:39 +0100 | |
commit | 0884f89431cd26bcc9674b3b7ab628b090f5881e (patch) | |
tree | cdd3b3f77f780a8b59d075dbcc3d4d013811e405 /docs/configuration/letsencrypt.md | |
parent | Update dependencies (#333) (diff) | |
download | gotosocial-0884f89431cd26bcc9674b3b7ab628b090f5881e.tar.xz |
Implement Cobra CLI tooling, Viper config tooling (#336)
* start pulling out + replacing urfave and config
* replace many many instances of config
* move more stuff => viper
* properly remove urfave
* move some flags to root command
* add testrig commands to root
* alias config file keys
* start adding cli parsing tests
* reorder viper init
* remove config path alias
* fmt
* change config file keys to non-nested
* we're more or less in business now
* tidy up the common func
* go fmt
* get tests passing again
* add note about the cliparsing tests
* reorganize
* update docs with changes
* structure cmd dir better
* rename + move some files around
* fix dangling comma
Diffstat (limited to 'docs/configuration/letsencrypt.md')
-rw-r--r-- | docs/configuration/letsencrypt.md | 55 |
1 files changed, 27 insertions, 28 deletions
diff --git a/docs/configuration/letsencrypt.md b/docs/configuration/letsencrypt.md index 05953cbb7..4e3a6d59b 100644 --- a/docs/configuration/letsencrypt.md +++ b/docs/configuration/letsencrypt.md @@ -8,36 +8,35 @@ ############################## # Config pertaining to the automatic acquisition and use of LetsEncrypt HTTPS certificates. -letsEncrypt: - # Bool. Whether or not letsencrypt should be enabled for the server. - # If false, the rest of the settings here will be ignored. - # You should only change this if you want to serve GoToSocial behind a reverse proxy - # like Traefik, HAProxy, or Nginx. - # Options: [true, false] - # Default: true - enabled: true +# Bool. Whether or not letsencrypt should be enabled for the server. +# If false, the rest of the settings here will be ignored. +# You should only change this if you want to serve GoToSocial behind a reverse proxy +# like Traefik, HAProxy, or Nginx. +# Options: [true, false] +# Default: true +letsencrypt-enabled: true - # Int. Port to listen for letsencrypt certificate challenges on. - # If letsencrypt is enabled, this port must be reachable or you won't be able to obtain certs. - # If letsencrypt is disabled, this port will not be used. - # This *must not* be the same as the webserver/API port specified above. - # Examples: [80, 8000, 1312] - # Default: 80 - port: 80 +# Int. Port to listen for letsencrypt certificate challenges on. +# If letsencrypt is enabled, this port must be reachable or you won't be able to obtain certs. +# If letsencrypt is disabled, this port will not be used. +# This *must not* be the same as the webserver/API port specified above. +# Examples: [80, 8000, 1312] +# Default: 80 +letsencrypt-port: 80 - # String. Directory in which to store LetsEncrypt certificates. - # It is a good move to make this a sub-path within your storage directory, as it makes - # backup easier, but you might wish to move them elsewhere if they're also accessed by other services. - # In any case, make sure GoToSocial has permissions to write to / read from this directory. - # Examples: ["/home/gotosocial/storage/certs", "/acmecerts"] - # Default: "/gotosocial/storage/certs" - certDir: "/gotosocial/storage/certs" +# String. Directory in which to store LetsEncrypt certificates. +# It is a good move to make this a sub-path within your storage directory, as it makes +# backup easier, but you might wish to move them elsewhere if they're also accessed by other services. +# In any case, make sure GoToSocial has permissions to write to / read from this directory. +# Examples: ["/home/gotosocial/storage/certs", "/acmecerts"] +# Default: "/gotosocial/storage/certs" +letsencrypt-cert-dir: "/gotosocial/storage/certs" - # String. Email address to use when registering LetsEncrypt certs. - # Most likely, this will be the email address of the instance administrator. - # LetsEncrypt will send notifications about expiring certificates etc to this address. - # Examples: ["admin@example.org"] - # Default: "" - emailAddress: "" +# String. Email address to use when registering LetsEncrypt certs. +# Most likely, this will be the email address of the instance administrator. +# LetsEncrypt will send notifications about expiring certificates etc to this address. +# Examples: ["admin@example.org"] +# Default: "" +letsencrypt-email-address: "" ``` |