Add docs for SECRETS_VERBOSE, env vars (#398)

This commit is contained in:
Josh Rabinowitz 2019-03-07 20:25:06 -05:00 committed by GitHub
parent 22fe1ed2d4
commit 52b46ae700
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
18 changed files with 10 additions and 2 deletions

View File

@ -3,6 +3,7 @@
## {{Next Version}}
- Support SECRETS_VERBOSE env var to enable verbosity (#323)
- Document SECRETS_VERBOSE and improve env var docs (#396)
- Use gpg without --quiet when decrypting in verbose mode (#394)
- Add -v 'verbose' option to 'tell', showing gpg output (#320)
- Fix link to homebrew's git-secret in README.md (#310)

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

View File

@ -13,9 +13,11 @@ Verbose output is enabled with the -v option, in which case the program prints w
## OPTIONS
-v - shows which files are deleted.
-v - verbose mode, shows which files are deleted.
-h - shows this help.
You can also enable verbosity using the SECRETS_VERBOSE environment variable,
as documented at [git-secret(7)](http://git-secret.io/)
## MANUAL

Binary file not shown.

View File

@ -45,6 +45,8 @@ folder using the SECRETS_DIR environment variable.
-m - encrypt files only when modified.
-h - shows help.
You can also enable verbosity using the SECRETS_VERBOSE environment variable,
as documented at [git-secret(7)](http://git-secret.io/)
## MANUAL

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

View File

@ -47,7 +47,7 @@ Note that it is possible to add yourself to the git-secret repo without decrypti
It will be possible to decrypt them after re-encrypting them with the new keyring. So, if you don't
want unexpected keys added, you can configure some server-side security policy with the `pre-receive` hook.
## Configuration
## Environment Variables and Configuration
You can configure the version of gpg used, or the extension your encrypted files use, to suit your workflow better.
To do so, just set the required variable to the value you need.
@ -55,6 +55,9 @@ This can be done in your shell environment file or with each `git-secret` comman
The settings available to be changed are:
* `$SECRETS_VERBOSE` - sets the verbose flag to on for all `git-secret` commands; is identical
to using `-v` on each command that supports it.
* `$SECRETS_GPG_COMMAND` - sets the `gpg` alternatives, defaults to `gpg`.
It can be changed to `gpg`, `gpg2`, `pgp`, `/usr/local/gpg` or any other value.
After doing so rerun the tests to be sure that it won't break anything. Tested to be working with: `gpg`, `gpg2`.