git-secret/README.md

42 lines
2.1 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
[![git-secret](https://raw.githubusercontent.com/sobolevn/git-secret/gh-pages/images/git-secret-big.png)](http://git-secret.io/)
2016-07-02 14:16:12 +00:00
2016-07-02 13:18:53 +00:00
## What is `git-secret`?
2017-01-07 09:38:45 +00:00
`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 their public key, re-encrypt the files, and they 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
## Installation
2016-02-24 11:24:07 +00:00
`git-secret` supports `brew`, just type: `brew install git-secret`
2016-02-24 11:24:07 +00:00
It also supports `apt` and `yum`. You can also use `make` if you want to.
2016-03-13 10:06:18 +00:00
See the [installation section](http://git-secret.io/installation) for the details.
2016-03-13 10:06:18 +00:00
2016-07-02 13:18:53 +00:00
## Contributing
2016-02-21 13:26:17 +00:00
Do you want to help the project? Find an [issue](https://github.com/sobolevn/git-secret/issues) and send a PR. It is more than welcomed! See [CONTRIBUTING.md](CONTRIBUTING.md) on how to do that.
### Security
If you found any security related issues, please do not enclose it in public. Send an email to `security@wemake.services`
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
`git-secret` uses semver. See [CHANGELOG.md](CHANGELOG.md).
2016-02-21 13:26:17 +00:00
2016-07-02 13:18:53 +00:00
## License
2016-02-21 13:26:17 +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-03-13 10:06:18 +00:00
Special thanks to [Elio Qoshi](https://elioqoshi.me/sq/) from [ura](http://ura.design/) for the awesome logo.