diff options
Diffstat (limited to 'README')
| -rw-r--r-- | README | 23 |
1 files changed, 21 insertions, 2 deletions
| @@ -5,13 +5,32 @@ A simple password manager written in POSIX shell. | |||
| 5 | Dependencies | 5 | Dependencies |
| 6 | ------------ | 6 | ------------ |
| 7 | - POSIX-compliant environment | 7 | - POSIX-compliant environment |
| 8 | - gnupg | 8 | - age, gnupg, or any other utility to {en,de}crypt files |
| 9 | - tree (for listing all your passwords and their directories) | 9 | - tree (for listing all your passwords and their directories) |
| 10 | - a simple version is available in https://github.com/pyr/tree | 10 | - a simple version is available in https://github.com/pyr/tree |
| 11 | and in OpenBSD's ports | 11 | and in OpenBSD's ports |
| 12 | - can possibly be replaced with ls if you add ANGOU_LIST in your ~/.profile | ||
| 12 | - xsel (for copying password to clipboard, but can be changed to a different | 13 | - xsel (for copying password to clipboard, but can be changed to a different |
| 13 | command with the ANGOU_CLIPBOARD command that accepts stdin) | 14 | command with the ANGOU_CLIPBOARD command that accepts stdin) |
| 14 | 15 | ||
| 16 | Configuration | ||
| 17 | ------------- | ||
| 18 | In your ~/.profile or wherever you set environment variables, add something | ||
| 19 | like this if you use age: | ||
| 20 | export AGE_KEY=/nas/ssh/id_ed25519 | ||
| 21 | export AGE_PUB=${AGE_KEY}.pub | ||
| 22 | export ANGOU_DIR=/nas/angou-age | ||
| 23 | export ANGOU_ENCRYPT="age -R $AGE_PUB" | ||
| 24 | export ANGOU_DECRYPT="age -d -i $AGE_KEY -o -" | ||
| 25 | |||
| 26 | If you use GnuPG, then add: | ||
| 27 | export GPG_ID="user@email.tld" # or your key id | ||
| 28 | export ANGOU_DECRYPT="gpg -qd" | ||
| 29 | export ANGOU_ENCRYPT="gpg -er $GPG_ID -o -" | ||
| 30 | |||
| 31 | For some other file encryptor, you'd need to be able to output the encrypted | ||
| 32 | file to stdout or change the last line of edit() that runs $ANGOU_ENCRYPT. | ||
| 33 | |||
| 15 | Why should I use this over password-store? | 34 | Why should I use this over password-store? |
| 16 | ------------------------------------------ | 35 | ------------------------------------------ |
| 17 | Don't. For a serious answer, it's because this doesn't depend on bash. | 36 | Don't. For a serious answer, it's because this doesn't depend on bash. |
| @@ -23,4 +42,4 @@ Set the ANGOU_DIR environment variable to your password store directory. | |||
| 23 | Auto-complete | 42 | Auto-complete |
| 24 | ------------- | 43 | ------------- |
| 25 | If you use ksh, all you'd have to do is source contrib/autocomplete.ksh in your | 44 | If you use ksh, all you'd have to do is source contrib/autocomplete.ksh in your |
| 26 | kshrc. | 45 | kshrc. \ No newline at end of file |
