git-secret/README.md

38 lines
1.8 KiB
Markdown
Raw Normal View History

2016-02-21 13:26:17 +00:00
# git-secret
[![Build Status](https://img.shields.io/travis/sobolevn/git-secret/master.svg)](https://travis-ci.org/sobolevn/git-secret) [![Homebrew](https://img.shields.io/homebrew/v/git-secret.svg)](http://braumeister.org/formula/git-secret) [![Bintray deb](https://img.shields.io/bintray/v/sobolevn/deb/git-secret.svg)](https://bintray.com/sobolevn/deb/git-secret/view) [![Dockerhub](https://img.shields.io/docker/pulls/sobolevn/git-secret.svg)](https://hub.docker.com/r/sobolevn/git-secret/)
2016-07-02 13:18:53 +00:00
2016-07-02 14:16:12 +00:00
[![git-secret](https://raw.githubusercontent.com/sobolevn/git-secret/gh-pages/images/git-secret-big.png)](https://sobolevn.github.io/git-secret/)
2016-07-02 13:18:53 +00:00
## What is `git-secret`?
`git-secret` is a bash tool to store your private data inside a git repo. Hows 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 deal with all this 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, re-encrypt the files, and he wont be able to decrypt secrets anymore.
2016-02-21 13:26:17 +00:00
2016-02-24 11:24:07 +00:00
## Preview
[![git-secret terminal preview](https://asciinema.org/a/41811.png)](https://asciinema.org/a/41811?autoplay=1)
2016-02-24 11:24:07 +00:00
2016-03-13 10:06:18 +00:00
## Usage
2016-02-24 11:24:07 +00:00
See the [git-secret site](https://sobolevn.github.io/git-secret/).
2016-03-13 10:06:18 +00:00
## Installation
See the [installation section](https://sobolevn.github.io/git-secret/#installation).
2016-07-02 13:18:53 +00:00
## Contributing
2016-02-21 13:26:17 +00:00
2016-07-02 13:18:53 +00:00
See [CONTRIBUTING.md](CONTRIBUTING.md).
2016-02-21 13:26:17 +00:00
2016-07-02 13:18:53 +00:00
## Changelog
2016-02-21 13:26:17 +00:00
2016-07-02 13:18:53 +00:00
See [CHANGELOG.md](CHANGELOG.md).
2016-02-21 13:26:17 +00:00
2016-07-02 13:18:53 +00:00
## License
2016-03-13 10:06:18 +00:00
2016-07-02 13:18:53 +00:00
MIT. See [LICENSE.md](LICENSE.md) for details.
2016-07-02 14:16:12 +00:00
## Thanks
2016-07-04 09:40:41 +00:00
Special thanks to [Elio Qoshi](https://elioqoshi.me/sq/) from [ura](http://ura.al/) for the awesome logo.