Skip to content

Commit 826d0ea

Browse files
committed
Documentation tweaks
1 parent a6b55d7 commit 826d0ea

File tree

1 file changed

+10
-8
lines changed

1 file changed

+10
-8
lines changed

README.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -51,17 +51,19 @@ This software has the same license as Ansible, GPLv3.
5151
This can be useful when, for example, you're interpolating variables
5252
into the `regexp` argument of the built-in `lineinfile` module.
5353

54-
* `vault_from_gpg_agent.py` script that allows `ansible`'s `vault` to
55-
read its password via `gpg-agent`. See this [mailing_list_post] for
56-
the rationale. The script can be used like this:
57-
58-
ansible-playbook setup.yml --vault-password-file vault_from_gpg_agent.py
59-
60-
The script must be executable (`chmod +x vault_from_gpg_agent.py`).
54+
* `vault_from_gpg_agent.py`: A script that allows Ansible Vault to
55+
read its passphrase via `gpg-agent`, which can (relatively) securely
56+
keep your passphrase in memory and save you from having to enter it
57+
every time you run `ansible-playbook`. See
58+
[this mailing list post][vault GPG announcement] for more details.
59+
Use this script by setting `vault_password_file =
60+
vault_from_gpg_agent.py` in your Ansible configuration file, or use
61+
`--vault-password-file=vault_from_gpg_agent.py` on the command line.
62+
Make sure the script is executable!
6163

6264
[augtool_mod]: http://dsedivec.github.io/ansible-plugins/#augtool
6365
[augtool]: http://augeas.net/tour.html
6466
[load_gpg_vars_mod]: http://dsedivec.github.io/ansible-plugins/#load_gpg_vars
6567
[symlink_mod]: http://dsedivec.github.io/ansible-plugins/#symlink
6668
[vault]: http://blog.ansibleworks.com/2014/02/19/ansible-vault/
67-
[mailing_list_post]: http://grokbase.com/t/gg/ansible-project/14810bdwye/read-vault-password-using-gpg-agent
69+
[vault GPG announcement]: https://groups.google.com/d/msg/ansible-project/fHEW71FdPx0/qk8yNZMJzsEJ

0 commit comments

Comments
 (0)