diff options
author | Evans Murithi <murithievans80@gmail.com> | 2019-04-26 19:13:12 +0300 |
---|---|---|
committer | GitHub <noreply@github.com> | 2019-04-26 19:13:12 +0300 |
commit | 471edbe57a712e08bf1cedf4d437b94f51f8d268 (patch) | |
tree | 0fc73a4eba7032d69068c99021c4c04243cc2f1f /README.md | |
parent | 9389b8dd81f11111317321ae1ed13cd233d0c5f8 (diff) |
Allow accounts directory to be user customizable (#25)
Allow the user to change the directory of the accounts by setting the
`CLOAK_ACCOUNTS_DIR` environment variable.
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 14 |
1 files changed, 14 insertions, 0 deletions
@@ -117,6 +117,20 @@ To view the help of any of the subcommands below, add `-h` or `--help`, e.g. `cl This will open a file, using your preferred editor, to either save new recovery codes or view existing recovery codes. +## Customization + +By default `cloak` stores your accounts and recovery codes inside a `.cloak/` +directory found inside your `$HOME` folder if you are on Linux or macOS, or +inside your user profile folder if you are on Windows. + +To alter this, you can use the `CLOAK_ACCOUNTS_DIR` environment variable to +point `cloak` to the directory to use for storing your accounts and recovery +codes: + +```bash +export CLOAK_ACCOUNTS_DIR='/save/accounts/here/' # absolute path +``` + ## Contributions If you want to contribute to `cloak` you will have to clone the repository on your |