new links

pull/10/head
sobolevn 8 years ago
parent 368be9790a
commit 58c75eb0d2

@ -19,7 +19,7 @@
.
.IP "" 0
.
.SH "<a href=\"#intro\" data\-bare\-link=\"true\">Intro</a>"
.SH "Intro"
There\'s a known problem in server configuration and deploying, when you have to store your private data such as: database passwords, application secret\-keys, OAuth secret keys and so on, outside of the git repository\. Even if this repository is private, it is a security risk to just publish them into the world wide web\. What are the drawbacks of storing them separately?
.
.IP "1." 4
@ -43,7 +43,7 @@ When building the automated deploment system there will be one extra step: downl
.SS "What is <code>git\-secret</code>?"
\fBgit\-secret\fR is a bash tool to store your private data inside a \fBgit\fR repo\. How\'s that? Basically, it just encrypts, using \fBgpg\fR, the tracked files with the public keys of all the users that you trust\. So everyone of them can decrypt these files using only their personal secret key\. Why to deal with all these private\-public keys stuff? Well, to make it easier for everyone to manage access rights\. There are no passwords that change\. When someone is out \- just delete his public key, reencrypt the files, and he won\'t be able to decrypt secrets anymore\.
.
.SH "<a href=\"#install\" data\-bare\-link=\"true\">Installation</a>"
.SH "Installation"
.
.SS "Dependencies"
\fBgit secret\fR relies on two dependecies: \fBgit\fR \fIhttps://git\-scm\.com/\fR and \fBgpg\fR \fIhttps://www\.gnupg\.org/\fR\. Download and install them before using this project\. \fBgit\-secret\fR is tested to work with:
@ -93,7 +93,7 @@ Run \fBsource ~/\.zshrc\fR or reopen the terminal
.P
\fBbrew\fR and \fBfpm\fR support is planned\.
.
.SH "<a href=\"#usage\" data\-bare\-link=\"true\">Usage</a>"
.SH "Usage"
These steps cover the basic process of using \fBgit\-secret\fR:
.
.IP "1." 4

@ -1,10 +1,10 @@
## Content
1. [Intro](#intro)
2. [Installation](#install)
2. [Installation](#installation)
3. [Usage](#usage)
## [Intro](#intro)
## Intro
There's a known problem in server configuration and deploying, when you have to store your private data such as: database passwords, application secret-keys, OAuth secret keys and so on, outside of the git repository. Even if this repository is private, it is a security risk to just publish them into the world wide web. What are the drawbacks of storing them separately?
@ -20,7 +20,7 @@ There's a known problem in server configuration and deploying, when you have to
`git-secret` is a bash tool to store your private data inside a `git` repo. How's that? Basically, it just encrypts, using `gpg`, the tracked files with the public keys of all the users that you trust. So everyone of them can decrypt these files using only their personal secret key. Why to deal with all these private-public keys stuff? Well, to make it easier for everyone to manage access rights. There are no passwords that change. When someone is out - just delete his public key, reencrypt the files, and he won't be able to decrypt secrets anymore.
## [Installation](#install)
## Installation
### Dependencies
@ -52,7 +52,7 @@ There are several ways to install `git-secret`:
`brew` and `fpm` support is planned.
## [Usage](#usage)
## Usage
These steps cover the basic process of using `git-secret`:
0. Before starting, make sure you have created `gpg` RSA key-pair: public and secret key identified by your email address.

Loading…
Cancel
Save