aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorNiall Sheridan <nsheridan@gmail.com>2016-12-28 14:54:57 +0000
committerNiall Sheridan <nsheridan@gmail.com>2016-12-28 15:01:58 +0000
commitd7129803488e81e6df691161b774908bf801e527 (patch)
tree5391b7ad94435086c5e3a5937e1118580a17edfd /README.md
parente0a1ccb64a637673195804513902cba6b1d4e97c (diff)
Add LetsEncrypt support
When configured the server will request a TLS certificate for the specified server name from LetsEncrypt
Diffstat (limited to 'README.md')
-rw-r--r--README.md2
1 files changed, 2 insertions, 0 deletions
diff --git a/README.md b/README.md
index 493f60c..a9d68a6 100644
--- a/README.md
+++ b/README.md
@@ -103,6 +103,8 @@ For any option that takes a file path as a parameter (e.g. SSH signing key, TLS
- `use_tls` : boolean. If this is set then `tls_key` and `tls_cert` are required.
- `tls_key` : string. Path to the TLS key. See the [note](#a-note-on-files) on files above.
- `tls_cert` : string. Path to the TLS cert. See the [note](#a-note-on-files) on files above.
+- `letsencrypt_servername`: string. If set will request a certificate from LetsEncrypt. This should match the expected FQDN of the server.
+- `letsencrypt_cachedir: string. Directory to cache the LetsEncrypt certificate.
- `address` : string. IP address to listen on. If unset the server listens on all addresses.
- `port` : int. Port to listen on.
- `user` : string. User to which the server drops privileges to.