aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMartin Ashby <martin@ashbysoft.com>2021-07-04 17:30:29 +0100
committerSimon Ser <contact@emersion.fr>2021-07-04 18:33:46 +0200
commitfdfde5bad5274ab9ccc81f55a0b9a590d422e7d2 (patch)
treeb329cc154f4dac3bc7c199038f6149d93abb5b8a
parente64550207ce0f6863eef1d2375a45c94612bfb96 (diff)
downloadalps-fdfde5bad5274ab9ccc81f55a0b9a590d422e7d2.tar.gz
alps-fdfde5bad5274ab9ccc81f55a0b9a590d422e7d2.zip
Add documentation for -login-key cli option
-rw-r--r--docs/cli.md8
1 files changed, 8 insertions, 0 deletions
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