mirror of
https://github.com/sobolevn/git-secret
synced 2024-10-31 21:20:29 +00:00
documentation update
This commit is contained in:
parent
c1db98a4d3
commit
cde42992da
@ -1,7 +1,7 @@
|
||||
---
|
||||
layout: post
|
||||
title: 'git-secret-add'
|
||||
date: 2016-02-24 14:24:21 +0300
|
||||
date: 2016-02-24 14:27:19 +0300
|
||||
categories: command
|
||||
---
|
||||
git-secret-add - starts to track added files.
|
||||
|
@ -1,7 +1,7 @@
|
||||
---
|
||||
layout: post
|
||||
title: 'git-secret-clean'
|
||||
date: 2016-02-24 14:24:21 +0300
|
||||
date: 2016-02-24 14:27:19 +0300
|
||||
categories: command
|
||||
---
|
||||
git-secret-clean - removes all the hidden files.
|
||||
|
@ -1,7 +1,7 @@
|
||||
---
|
||||
layout: post
|
||||
title: 'git-secret-hide'
|
||||
date: 2016-02-24 14:24:21 +0300
|
||||
date: 2016-02-24 14:27:19 +0300
|
||||
categories: command
|
||||
---
|
||||
git-secret-hide - encrypts all added files with the inner keyring.
|
||||
|
@ -1,7 +1,7 @@
|
||||
---
|
||||
layout: post
|
||||
title: 'git-secret-init'
|
||||
date: 2016-02-24 14:24:21 +0300
|
||||
date: 2016-02-24 14:27:19 +0300
|
||||
categories: command
|
||||
---
|
||||
git-secret-init - initializes git-secret repository.
|
||||
|
@ -1,7 +1,7 @@
|
||||
---
|
||||
layout: post
|
||||
title: 'git-secret-killperson'
|
||||
date: 2016-02-24 14:24:21 +0300
|
||||
date: 2016-02-24 14:27:19 +0300
|
||||
categories: command
|
||||
---
|
||||
git-secret-killperson - deletes key identified by an email from the inner keyring.
|
||||
|
@ -1,7 +1,7 @@
|
||||
---
|
||||
layout: post
|
||||
title: 'git-secret-list'
|
||||
date: 2016-02-24 14:24:21 +0300
|
||||
date: 2016-02-24 14:27:19 +0300
|
||||
categories: command
|
||||
---
|
||||
git-secret-list - prints all the added files.
|
||||
|
@ -1,7 +1,7 @@
|
||||
---
|
||||
layout: post
|
||||
title: 'git-secret-remove'
|
||||
date: 2016-02-24 14:24:21 +0300
|
||||
date: 2016-02-24 14:27:19 +0300
|
||||
categories: command
|
||||
---
|
||||
git-secret-remove - removes files from index.
|
||||
|
@ -1,7 +1,7 @@
|
||||
---
|
||||
layout: post
|
||||
title: 'git-secret-reveal'
|
||||
date: 2016-02-24 14:24:21 +0300
|
||||
date: 2016-02-24 14:27:19 +0300
|
||||
categories: command
|
||||
---
|
||||
git-secret-reveal - decrypts all added files.
|
||||
|
@ -1,7 +1,7 @@
|
||||
---
|
||||
layout: post
|
||||
title: 'git-secret-tell'
|
||||
date: 2016-02-24 14:24:21 +0300
|
||||
date: 2016-02-24 14:27:19 +0300
|
||||
categories: command
|
||||
---
|
||||
git-secret-tell - adds a person, who can access a private data.
|
||||
|
@ -1,7 +1,7 @@
|
||||
---
|
||||
layout: post
|
||||
title: 'git-secret-usage'
|
||||
date: 2016-02-24 14:24:21 +0300
|
||||
date: 2016-02-24 14:27:19 +0300
|
||||
categories: command
|
||||
---
|
||||
git-secret-usage - prints all the available commands.
|
||||
|
@ -1,7 +1,7 @@
|
||||
---
|
||||
layout: post
|
||||
title: 'git-secret-whoknows'
|
||||
date: 2016-02-24 14:24:21 +0300
|
||||
date: 2016-02-24 14:27:19 +0300
|
||||
categories: command
|
||||
---
|
||||
git-secret-whoknows - prints email-labels for each key in the keyring.
|
||||
|
@ -1,16 +1,16 @@
|
||||
---
|
||||
layout: post
|
||||
title: 'git-secret'
|
||||
date: 2016-02-24 14:24:21 +0300
|
||||
date: 2016-02-24 14:27:19 +0300
|
||||
categories: usage
|
||||
---
|
||||
## 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?
|
||||
|
||||
@ -26,7 +26,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
|
||||
|
||||
@ -58,7 +58,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.
|
||||
|
Binary file not shown.
@ -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…
Reference in New Issue
Block a user