summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README24
1 files changed, 12 insertions, 12 deletions
diff --git a/README b/README
index d6d1d42..0ab4de6 100644
--- a/README
+++ b/README
@@ -1,5 +1,5 @@
1angou (暗号) 1kasi ("veil"/"conceal" in Esperanto)
2============ 2====================================
3A simple password manager written in POSIX shell. 3A simple password manager written in POSIX shell.
4 4
5Dependencies 5Dependencies
@@ -9,13 +9,13 @@ Dependencies
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 - can possibly be replaced with ls if you add KASI_LIST in your ~/.profile
13- 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
14 command with the ANGOU_CLIPBOARD command that accepts stdin) 14 command with the KASI_CLIPBOARD command that accepts stdin)
15- a password generator 15- a password generator
16 - script uses contrib/random from this repo by default and expects it in your 16 - script uses contrib/random from this repo by default and expects it in your
17 path 17 path
18 - can change by setting ANGOU_GEN_USER and ANGOU_GEN_PASS in your ~/.profile 18 - can change by setting KASI_GEN_USER and KASI_GEN_PASS in your ~/.profile
19 19
20Configuration 20Configuration
21------------- 21-------------
@@ -23,17 +23,17 @@ In your ~/.profile or wherever you set environment variables, add something
23like this if you use age: 23like this if you use age:
24export AGE_KEY=/nas/ssh/id_ed25519 24export AGE_KEY=/nas/ssh/id_ed25519
25export AGE_PUB=${AGE_KEY}.pub 25export AGE_PUB=${AGE_KEY}.pub
26export ANGOU_DIR=/nas/angou-age 26export KASI_DIR=/nas/kasi-age
27export ANGOU_ENCRYPT="age -R $AGE_PUB" 27export KASI_ENCRYPT="age -R $AGE_PUB"
28export ANGOU_DECRYPT="age -d -i $AGE_KEY -o -" 28export KASI_DECRYPT="age -d -i $AGE_KEY -o -"
29 29
30If you use GnuPG, then add: 30If you use GnuPG, then add:
31export GPG_ID="user@email.tld" # or your key id 31export GPG_ID="user@email.tld" # or your key id
32export ANGOU_DECRYPT="gpg -qd" 32export KASI_DECRYPT="gpg -qd"
33export ANGOU_ENCRYPT="gpg -er $GPG_ID -o -" 33export KASI_ENCRYPT="gpg -er $GPG_ID -o -"
34 34
35For some other file encryptor, you'd need to be able to output the encrypted 35For some other file encryptor, you'd need to be able to output the encrypted
36file to stdout or change the last line of edit() that runs $ANGOU_ENCRYPT. 36file to stdout or change the last line of edit() that runs $KASI_ENCRYPT.
37 37
38Why should I use this over password-store? 38Why should I use this over password-store?
39------------------------------------------ 39------------------------------------------
@@ -41,7 +41,7 @@ Don't. For a serious answer, it's because this doesn't depend on bash.
41 41
42Migrating from password-store 42Migrating from password-store
43----------------------------- 43-----------------------------
44Set the ANGOU_DIR environment variable to your password store directory. 44Set the KASI_DIR environment variable to your password store directory.
45 45
46Auto-complete 46Auto-complete
47------------- 47-------------