2017-02-26 20:53:33 +00:00
|
|
|
---
|
|
|
|
|
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:
|
|
|
|
|
|
2021-05-04 10:06:48 +00:00
|
|
|
```
|
|
|
|
|
git version 2.7.0
|
|
|
|
|
gpg (GnuPG) 1.4.20
|
|
|
|
|
```
|
2017-02-26 20:53:33 +00:00
|
|
|
|
|
|
|
|
## Supported platforms
|
|
|
|
|
|
2021-05-04 10:06:48 +00:00
|
|
|
`git-secret` works with `Mac OS X` >= 10.9, `Ubuntu` >= 14.04, `Debian` >= 8.3, and `Fedora` / `CentOS`.
|
|
|
|
|
You can check the full list [here](https://github.com/sobolevn/git-secret/blob/issue-657/.github/workflows/test.yml).
|
2017-02-26 20:53:33 +00:00
|
|
|
You can add your platform to this list, if all the tests pass for you.
|
2020-12-15 15:50:27 +00:00
|
|
|
`Cygwin` support [is planned](https://github.com/sobolevn/git-secret/issues/40).
|
2017-02-26 20:53:33 +00:00
|
|
|
|
|
|
|
|
## Installation process
|
|
|
|
|
|
|
|
|
|
There are several ways to install `git-secret`:
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
### Homebrew
|
|
|
|
|
|
|
|
|
|
`brew install git-secret`
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
### `deb` package
|
|
|
|
|
|
2021-05-04 19:07:11 +00:00
|
|
|
You can find the `deb` repository [here](https://gitsecret.jfrog.io/artifactory/git-secret-deb/).
|
2021-05-04 10:06:48 +00:00
|
|
|
Pre-requirements: make sure you have installed `apt-transport-https` and `ca-certificates`
|
2017-02-26 20:53:33 +00:00
|
|
|
|
|
|
|
|
```bash
|
2021-05-04 18:59:01 +00:00
|
|
|
sudo sh -c "echo 'deb https://gitsecret.jfrog.io/artifactory/git-secret-deb git-secret main' >> /etc/apt/sources.list"
|
2021-05-04 19:16:06 +00:00
|
|
|
wget -qO - https://gitsecret.jfrog.io/artifactory/api/gpg/key/public | sudo apt-key add -
|
2021-05-04 18:59:01 +00:00
|
|
|
sudo apt-get update
|
|
|
|
|
sudo apt-get install git-secret
|
2017-02-26 20:53:33 +00:00
|
|
|
```
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
### `rpm` package
|
|
|
|
|
|
2021-05-04 19:07:11 +00:00
|
|
|
You can find the `rpm` repository [here](https://gitsecret.jfrog.io/artifactory/git-secret-rpm/).
|
2017-02-26 20:53:33 +00:00
|
|
|
|
|
|
|
|
```bash
|
2021-05-04 18:59:01 +00:00
|
|
|
wget https://raw.githubusercontent.com/sobolevn/git-secret/master/utils/rpm/git-secret.repo -O git-secret-rpm.repo
|
|
|
|
|
# Inspect what's inside! You can also enable `gpg` check on repo level.
|
|
|
|
|
sudo mv git-secret-rpm.repo /etc/yum.repos.d/
|
2017-02-26 20:53:33 +00:00
|
|
|
sudo yum install git-secret
|
|
|
|
|
```
|
|
|
|
|
|
2020-02-11 02:53:40 +00:00
|
|
|
### Arch Linux
|
2020-02-07 21:23:39 +00:00
|
|
|
|
2020-02-11 02:53:40 +00:00
|
|
|
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/)
|
|
|
|
|
|
2021-05-04 10:06:48 +00:00
|
|
|
You can also install from the [AUR](https://aur.archlinux.org/) using your helper of choice by
|
2020-02-11 02:53:40 +00:00
|
|
|
installing the package `git-secret`, for example using [yay](https://github.com/Jguer/yay)
|
2020-02-07 21:23:39 +00:00
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
yay -S git-secret
|
|
|
|
|
```
|
|
|
|
|
|
2017-02-26 20:53:33 +00:00
|
|
|
---
|
|
|
|
|
|
|
|
|
|
### 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`
|
