Skip to content

Commit

Permalink
Add gpg-agent usage instructions to the README [ref #18]
Browse files Browse the repository at this point in the history
  • Loading branch information
Oleiade committed Nov 24, 2013
1 parent 479ddce commit 66820e6
Showing 1 changed file with 15 additions and 1 deletion.
16 changes: 15 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,11 @@ sudo cp ./bin/trousseau /usr/local/bin/trousseau
### Gpg passphrase

Every decryption operations will require your *gpg* primary key passphrase.
As of today, **trousseau** is able to handle your passphrase through your system's keyring manager, the system environment or the global option ``--passphrase``.
As of today, **trousseau** is able to handle your passphrase through multiple ways:
* system's keyring manager
* gpg-agent daemon
* system environment
* ``--passphrase`` global option

#### Keyring manager

Expand All @@ -95,6 +99,16 @@ $ export TROUSSEAU_KEYRING_SERVICE=my_keyring_key
$ trousseau get abc
```

#### Gpg agent

Another authentication method supported is gpg-agent. In order to use it make sure you've started the gpg-agent daemon and exported the ``GPG_AGENT_INFO`` variable, trousseau will do the rest.

```bash
$ export GPG_AGENT_INFO=path_to_the_gpg_agent_info_file
$ export [email protected]
$ trousseau get abc
```

#### Environment variable

Alternatively, you can pass your primary key passphrase as `TROUSSEAU_PASSPHRASE` environment variable:
Expand Down

0 comments on commit 66820e6

Please sign in to comment.