aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNiall Sheridan <nsheridan@gmail.com>2017-08-14 17:02:22 +0100
committerNiall Sheridan <nsheridan@gmail.com>2017-08-14 17:02:22 +0100
commit05b307cb695eac082b4dced2385a7700434ab17b (patch)
tree36de8a968d9eb2a51eb2423515dfa6465bdab843
parent68518d85c9b6707223471d73608971cc6b03c1ac (diff)
Add a note about the dangers of relying on dropping privs in Go
-rw-r--r--README.md2
1 files changed, 1 insertions, 1 deletions
diff --git a/README.md b/README.md
index c861162..8dc43f1 100644
--- a/README.md
+++ b/README.md
@@ -109,7 +109,7 @@ Exception to this: the `http_logfile` option **ONLY** writes to local files.
- `letsencrypt_cachedir`: string. Directory to cache the LetsEncrypt certificate. See the [note](#a-note-on-files) on files above.
- `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.
+- `user` : string. User to which the server drops privileges to. *Note* Dropping privileges might not work as expected as some [threads may retain their privileges due to the limitations of the Go runtime](https://github.com/golang/go/issues/1435).
- `cookie_secret`: string. Authentication key for the session cookie. This can be a secret stored in a [vault](https://www.vaultproject.io/) using the form `/vault/path/key` e.g. `/vault/secret/cashier/cookie_secret`.
- `csrf_secret`: string. Authentication key for CSRF protection. This can be a secret stored in a [vault](https://www.vaultproject.io/) using the form `/vault/path/key` e.g. `/vault/secret/cashier/csrf_secret`.
- `http_logfile`: string. Path to the HTTP request log. Logs are written in the [Common Log Format](https://en.wikipedia.org/wiki/Common_Log_Format). The only valid destination for logs is a local file path.