aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-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.