aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJosh Rahm <joshuarahm@gmail.com>2023-02-24 17:02:09 -0700
committerJosh Rahm <joshuarahm@gmail.com>2023-02-24 17:02:09 -0700
commitab5edd3b2219ec267348baed9647694e6f2ede3f (patch)
tree19dd317ee000eab546e9f0f5d797c3160051a7fe
parent603f7cb08bca86744949a709c04952c845d6f28d (diff)
downloadkeyper-ab5edd3b2219ec267348baed9647694e6f2ede3f.tar.gz
keyper-ab5edd3b2219ec267348baed9647694e6f2ede3f.tar.bz2
keyper-ab5edd3b2219ec267348baed9647694e6f2ede3f.zip
Add disable documentation.
-rw-r--r--README.md7
1 files changed, 7 insertions, 0 deletions
diff --git a/README.md b/README.md
index 53e3638..66c0ddd 100644
--- a/README.md
+++ b/README.md
@@ -42,3 +42,10 @@ $ ssh keyper@keyserver > /tmp/key
$ sudo luksAddKey /dev/<disk> /tmp/key
$ shred /tmp/key
```
+
+## Disabling Keyper
+
+Keyper can be temporarily disabled by `touch`-ing a file. This file defaults to
+`keyper-disabled` (in keyper's HOME directory), but can be overriden to any file
+by setting the environment `KEYPER_DISABLE_FILE`. When this file exists, keyper
+will exit with an error.