From 48c15e2daa7b3f4c84526bd9f030828f378edfc2 Mon Sep 17 00:00:00 2001 From: Julian Swagemakers Date: Tue, 13 Nov 2018 08:57:53 +0100 Subject: [PATCH] docs: update pass documentation with password-name This will update the README.md to include setting the configuration option password-name when using pass. --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.md b/README.md index 67786bb..6d89d45 100644 --- a/README.md +++ b/README.md @@ -484,6 +484,7 @@ After setting this and issuing a `jira login`, your credentials will be stored i An alternative to the keyring password source is the `pass` tool (documentation [here](https://www.passwordstore.org/)). This uses gpg to encrypt/decrypt passwords on demand and by using `gpg-agent` you can cache the gpg credentials for a period of time so you will not be prompted repeatedly for decrypting the passwords. The advantage over the keyring integration is that `pass` can be used on more platforms than OSX and Linux, although it does require more setup. To use `pass` for password storage and retrieval via `go-jira` just add this configuration to `$HOME/.jira.d/config.yml`: ```yaml password-source: pass +password-name: jira.example.com/myuser ``` This assumes you have already setup `pass` correctly on your system. Specifically you will need to have created a gpg key like this: @@ -507,6 +508,12 @@ Then initialize the `pass` tool to use the correct key: $ pass init "Go Jira " ``` +Now insert your password with the name you configured. + +``` +$ pass insert jira.example.com/myuser +``` + You probably want to setup gpg-agent so that you don't have to type in your gpg passphrase all the time. You can get `gpg-agent` to automatically start by adding something like this to your `$HOME/.bashrc` ```bash if [ -f $HOME/.gpg-agent-info ]; then