@ -69,29 +72,38 @@ There are several ways to install \fBgit\-secret\fR:
\fBBrew\fR
\fBBrew\fR
.
.
.IP"1."4
.IP"1."4
Run \fBbrew install sobolevn/tap/git\-secret\fR
Run \fBbrew install git\-secret\fR\. That will do\. Also, there are two options:
.
.IP"2."4
\fB\-\-without\-gpg\fR to build without \fBgpg\fR support
.
.IP"3."4
\fB\-\-HEAD\fR to install \fBHEAD\fR version
.
.IP"4."4
Note, that we have migrated from \fBtap\fR to the official \fBbrew\fR repo
.
.
.IP""0
.IP""0
.
.
.P
.P
\fB\fBantigen\fR plugin (or any other \fBoh\-my\-zsh\fR\-styled plugin\-systems)\fR
\fBManual\fR
.
.
.IP"1."4
.IP"1."4
Add line \fBantigen bundle sobolevn/git\-secret\fR to your \fB\.zshrc\fR
Clone the repository first: \fBgit clone https://github\.com/sobolevn/git\-secret\.git git\-secret\fR
.
.
.IP"2."4
.IP"2."4
Run \fBsource ~/\.zshrc\fR or reopen the terminal
Run \fBPREFIX="/usr/local" make install\fR, note that you can install to any prefix in your \fBPATH\fR
.
.
.IP""0
.IP""0
.
.
.P
.P
\fB\fBmake install\fR\fR
\fB\fBantigen\fR plugin (or any other \fBoh\-my\-zsh\fR\-styled plugin\-systems)\fR
.
.
.IP"1."4
.IP"1."4
Download the latest realease here \fIhttps://github\.com/sobolevn/git\-secret/releases\fR
Add line \fBantigen bundle sobolevn/git\-secret\fR to your \fB\.zshrc\fR
.
.
.IP"2."4
.IP"2."4
Unpack and run \fBmake install PREFIX="your/installation/path"\fR, note that this command may require \fBsudo\fR
Run \fBsource ~/\.zshrc\fR or reopen the terminal
.
.
.IP""0
.IP""0
.
.
@ -164,3 +176,18 @@ Reencypt the files, now they will be able to decrypt them with their secret key\
.
.
.P
.P
Note, that it is possible to add yourself to the system without decrypting existing files\. It will be possible to decrypt them after reencrypting them with the new keyring\. So, if you don\'t want unexpected keys added, make sure to configure some server\-side security policy with the \fBpre\-receive\fR hook\.
Note, that it is possible to add yourself to the system without decrypting existing files\. It will be possible to decrypt them after reencrypting them with the new keyring\. So, if you don\'t want unexpected keys added, make sure to configure some server\-side security policy with the \fBpre\-receive\fR hook\.
.
.SH"Configuration"
You can configure several things to suit your workflow better\. To do so, just set the required variable to the value you need\. This can be done in your shell environment file or with the each \fBgit\-secret\fR command\.
.
.P
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\.
.
.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\.