From fdfde5bad5274ab9ccc81f55a0b9a590d422e7d2 Mon Sep 17 00:00:00 2001 From: Martin Ashby Date: Sun, 4 Jul 2021 17:30:29 +0100 Subject: [PATCH] Add documentation for -login-key cli option --- docs/cli.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/docs/cli.md b/docs/cli.md index ca7c7e8..4ca2bbf 100644 --- a/docs/cli.md +++ b/docs/cli.md @@ -35,10 +35,18 @@ The following URL schemes are supported: **-debug**: enable debug logs and print IMAP network activity +**-login-key**: supply a secret key to preserve logins over application restart. + **-h**, **--help**: show help message and exit # SIGNALS **SIGUSR1**: reloads templates and Lua plugins +# LOGIN-KEY + +A login key can be used to preserve user sessions over application restarts if +the user has selected 'remember me' on the login page. A key can be generated +by running `go run github.com/fernet/fernet-go/cmd/fernet-keygen` + [RFC 6186]: https://tools.ietf.org/html/rfc6186