mirror of
https://github.com/sobolevn/git-secret
synced 2024-11-08 19:10:31 +00:00
eafd3fc531
* Migrate docs to master branch, add action to deploy to pages branch on push * Update docs, build pipeline to reflect new method of updating gh-pages * Removed make build-gh-pages from post-commit hook Co-authored-by: Josh Rabinowitz <joshr@joshr.com>
91 lines
2.3 KiB
Markdown
91 lines
2.3 KiB
Markdown
---
|
|
layout: default
|
|
---
|
|
|
|
# Installation
|
|
|
|
## Dependencies
|
|
|
|
`git-secret` relies on two dependencies: `git` and `gpg`. Download and install them before using this project. `git-secret` is tested to work with:
|
|
|
|
git version 2.7.0
|
|
gpg (GnuPG) 1.4.20
|
|
|
|
## Supported platforms
|
|
|
|
`git-secret` works with `Mac OS X` >= 10.9, `Ubuntu` >= 14.04, `Debian` >= 8.3, and `Fedora`.
|
|
You can check the full list [here](https://travis-ci.org/sobolevn/git-secret).
|
|
You can add your platform to this list, if all the tests pass for you.
|
|
`Cygwin` support [is planned](https://github.com/sobolevn/git-secret/issues/40).
|
|
|
|
## Installation process
|
|
|
|
There are several ways to install `git-secret`:
|
|
|
|
---
|
|
|
|
### Homebrew
|
|
|
|
`brew install git-secret`
|
|
|
|
---
|
|
|
|
### `deb` package
|
|
|
|
You can find the `deb` repository [here](https://bintray.com/sobolevn/deb/git-secret).
|
|
Pre-requirements: make sure you have installed `apt-transport-https`
|
|
|
|
```bash
|
|
echo "deb https://dl.bintray.com/sobolevn/deb git-secret main" | sudo tee -a /etc/apt/sources.list
|
|
wget -qO - https://api.bintray.com/users/sobolevn/keys/gpg/public.key | sudo apt-key add -
|
|
sudo apt-get update && sudo apt-get install git-secret
|
|
```
|
|
|
|
---
|
|
|
|
### `rpm` package
|
|
|
|
You can find the `rpm` repository [here](https://bintray.com/sobolevn/rpm/git-secret).
|
|
|
|
```bash
|
|
wget https://bintray.com/sobolevn/rpm/rpm -O bintray-sobolevn-rpm.repo
|
|
sudo mv bintray-sobolevn-rpm.repo /etc/yum.repos.d/
|
|
sudo yum install git-secret
|
|
```
|
|
|
|
### Arch Linux
|
|
|
|
The _Arch_ way to install git-secret is to use the directions for
|
|
"Installing Packages" at [Arch User Repository Documentation](https://wiki.archlinux.org/index.php/Arch_User_Repository#Installing_packages)
|
|
along with the `PKGBUILD` file from the [git-secret Arch Linux Package](https://aur.archlinux.org/packages/git-secret/)
|
|
|
|
You can also install from the [AUR](https://aur.archlinux.org/) using your helper of choice by
|
|
installing the package `git-secret`, for example using [yay](https://github.com/Jguer/yay)
|
|
|
|
```bash
|
|
yay -S git-secret
|
|
```
|
|
|
|
---
|
|
|
|
### Manual
|
|
|
|
```bash
|
|
git clone https://github.com/sobolevn/git-secret.git git-secret
|
|
cd git-secret && make build
|
|
PREFIX="/usr/local" make install
|
|
```
|
|
|
|
Note that you can install to any prefix in your `PATH`
|
|
|
|
---
|
|
|
|
### `antigen` plugin
|
|
|
|
*Deprecated*
|
|
|
|
1. Add line `antigen bundle sobolevn/git-secret` to your `~/.zshrc`
|
|
2. Run `source ~/.zshrc` or reopen the terminal
|
|
|
|
---
|