Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

improve documentation about .gitsecret directory contents #144

Closed
joshrabinowitz opened this issue Apr 15, 2018 · 3 comments
Closed

improve documentation about .gitsecret directory contents #144

joshrabinowitz opened this issue Apr 15, 2018 · 3 comments
Assignees
Milestone

Comments

@joshrabinowitz
Copy link
Collaborator

As of 0.2.4, the docs talk about the .gitsecret directory:

(See the end of:
https:/sobolevn/git-secret/blob/master/man/man7/git-secret.7.ronn )

Can someone describe the contents of each file in a .gitsecret directory so I can write them up them in the docs?

Here's what I'm seeing in a .gitsecret directory, with a description of one file:

% find .gitsecret/ -type f
.gitsecret/paths/mapping.cfg 
.gitsecret/keys/mapping.cfg
.gitsecret/keys/trustdb.gpg
.gitsecret/keys/secring.gpg
.gitsecret/keys/pubring.gpg
.gitsecret/keys/random_seed  - seed used for keys, must be protected
@joshrabinowitz
Copy link
Collaborator Author

joshrabinowitz commented Apr 15, 2018

There are basic descriptions here:

https://www.gnupg.org/documentation/manuals/gnupg/GPG-Configuration.html

There's special mention about random_seed specifically being in .gitignore, and in git-secret.7.ronn it says that .gitsecret folder 'should not be ignored'.

Should all files except random_seed be checked in? Let's give clear guidance.

@sobolevn
Copy link
Owner

Yeap, all files except random_seed should be checked in.

mortenlj added a commit to fiaas/ops that referenced this issue Apr 16, 2018
@sobolevn sobolevn added this to the 0.2.4 milestone Apr 17, 2018
@joshrabinowitz
Copy link
Collaborator Author

The docs have been clarified on this topic

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants