\fBgit\-secret\-hide\fR\- encrypts all added files with the inner keyring\.
@ -15,7 +15,7 @@ git secret hide [\-c] [\-v]
.fi
.
.SH"DESCRIPTION"
\fBgit\-secret\-hide\fR create an encrypted version for each file added by \fBgit\-secret\-add\fR command\. Now anyone from the \fBgit\-secret\fR\'s keyring can decrypt these files using their secret key\.
\fBgit\-secret\-hide\fR creates an encrypted version for each file added by \fBgit\-secret\-add\fR command\. Now anyone from the \fBgit\-secret\fR\'s keyring can decrypt these files using their secret key\.
.
.P
It is possible to modify the names of the encrypted files by setting \fBSECRETS_EXTENSION\fR variable\.
@ -36,4 +36,4 @@ It is possible to modify the names of the encrypted files by setting \fBSECRETS_
Run \fBman git\-secret\-hide\fR to see this note\.
\fBgit\-secret\-reveal\fR\- decrypts all the files in the \fB\.gitsecret/paths/mapping\.cfg\fR by running a \fBgpg \-\-decrypt\fR command\. It is important to have paired secret\-key with one of the public\-keys, which were used in the encryption\.
\fBgit\-secret\-reveal\fR\- decrypts all the files in the \fB\.gitsecret/paths/mapping\.cfg\fR by running a \fBgpg \-\-decrypt\fR command\. It is important to have paired secret\-key with one of the public\-keys which were used in the encryption\.
@ -55,10 +55,25 @@ You can configure several things to suit your workflow better\. To do so, just s
These settings are available to be changed:
.
.IP"\(bu"4
\fB$SECRETS_GPG_COMMAND\fR\- sets the \fBgpg\fR alternatives, defaults to \fBgpg\fR\. It can be changed to \fBgpg\fR, \fBgpg2\fR, \fBpgp\fR, \fB/usr/local/gpg\fR or any other value\. After doing so rerun tests to be sure, that it won\'t break anything\. Tested to be working with: \fBgpg\fR, \fBgpg2\fR\.
\fB$SECRETS_GPG_COMMAND\fR\- sets the \fBgpg\fR alternatives, defaults to \fBgpg\fR\. It can be changed to \fBgpg\fR, \fBgpg2\fR, \fBpgp\fR, \fB/usr/local/gpg\fR or any other value\. After doing so rerun the tests to be sure, that it won\'t break anything\. Tested to be working with: \fBgpg\fR, \fBgpg2\fR\.
.
.IP"\(bu"4
\fB$SECRETS_EXTENSION\fR\- sets the secret files extension, defaults to \fB\.secret\fR\. It can be changed to any valid file extension\.
.
.IP""0
.
.SH"Internals"
.
.SS"<code>\.gitsecret</code> folder"
This folder contains every piece of information about the project\. It stores:
.
.IP"\(bu"4
public keys for the project
.
.IP"\(bu"4
path mappings\. Or in other words: what files are tracked to be hidden and revealed
.
.IP""0
.
.P
This folder should not be ignored\. In case it is application would not work raising an error: \fB\'\.gitsecret/\' is ignored\. abort\.\'\fR\. However, it is possible to ignore individual files \fIhttps://github\.com/sobolevn/git\-secret/issues/93\fR inside it: \fBrandom_seed\fR would be the most popular example\.