aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorAkshay Nair <phenax5@gmail.com>2022-02-27 15:57:58 +0530
committerGitHub <noreply@github.com>2022-02-27 15:57:58 +0530
commit63c307add0fde2d53238383aa9a0ffe79eb000aa (patch)
treeb2db8de6d21cb302239d83c78a84aaa5347a8bae /README.md
parent89b0adef42d95372c243cb8b86e1190172259fb7 (diff)
downloadanypinentry-63c307add0fde2d53238383aa9a0ffe79eb000aa.tar.gz
anypinentry-63c307add0fde2d53238383aa9a0ffe79eb000aa.zip
Update README.md
Diffstat (limited to 'README.md')
-rw-r--r--README.md21
1 files changed, 20 insertions, 1 deletions
diff --git a/README.md b/README.md
index e5d2b58..f001acc 100644
--- a/README.md
+++ b/README.md
@@ -2,5 +2,24 @@
AnyPinentry is a wrapping interface to all kinds of prompts instead of gnupg's pinentry.
You can now use any interface for password and confirmation prompts (`dmenu`, `rofi`, `read`, `systemd-ask-password`, `curses`, `etc`).
-WIP
+> Note: This isn't a complete replacement for pinentry programs but it should cover most use-cases.
+## Dependencies
+* bash
+* dmenu with password patch (for the default config only)
+* notify-send (for the default config only)
+
+## Usage
+1. Clone the repo to anywhere on your machine (you should maintain a fork in case you want to configure the default behavior)
+2. Run `chmod +x ./anypinentry` inside the cloned directory
+3. Edit the script file if you want to configure it.
+4. Edit `~/.gnuph/gpg-agent.conf` (or create it) and add the line `pinentry-program /<path-to-this-repo>/anypinentry`
+5. Run `gpg-agent reload` to reload the config or logout and log back in
+6. Gpg should now be using your prefered program for pinentry
+
+## Config
+The following variables inside `./anypinentry` script file can be configured
+
+* `prompt_action` - Action to show a prompt asking for password
+* `confirm_action` - Action to confirm an action (Yes or No)
+* `display_error_action` - Action to display error messages to user