## Ory Oathkeeper Installation Guide

Ory software runs on any operating system (FreeBSD, macOS, Linux, Windows, ...) and supports all major CPU platforms (ARM64, ARMv7, x86_64, x86, ...).

### Supported Operating Systems
- macOS
- Linux
- Windows
- Docker
- Kubernetes

### Install Ory Oathkeeper using Homebrew on macOS:
```shell
brew install ory/tap/oathkeeper

oathkeeper help
```

### Install Ory Oathkeeper on Linux using `bash <(curl ...)`:
```shell
bash <(curl https://raw.githubusercontent.com/ory/meta/master/install.sh) -d -b . oathkeeper v26.2.0

./oathkeeper help
```

You may want to move Ory Oathkeeper to your `$PATH`:
```shell
sudo mv ./oathkeeper /usr/local/bin/

oathkeeper help
```

### Install Ory Oathkeeper on Windows using Scoop:
```shell
scoop bucket add ory https://github.com/ory/scoop.git

scoop install oathkeeper

oathkeeper help
```

### Docker Image
Ory Oathkeeper is available as a Docker Image for all major platforms (ARM64, AMD64, ...):
```shell
docker pull oryd/oathkeeper:v26.2.0

docker run --rm -it oryd/oathkeeper:v26.2.0 help
```

A list of available Helm Charts for Kubernetes can be found at [k8s.ory.com/helm](https://k8s.ory.com/helm).

## Download Binaries
You can download the client and server binaries on our [Github releases](https://github.com/ory/oathkeeper/releases) page. No installer is available. You have to add the binary to the PATH in your environment yourself, for example by putting it into `/usr/local/bin` or something comparable.

Once installed, you should be able to run:
```shell
oathkeeper help
```

## Building from Source
If you wish to compile the binary yourself, you need to install and set up [Go 1.17+](https://golang.org/) and add `$GOPATH/bin` to your `$PATH`.

**Note**: Please be aware that this will check out the latest commit, which might be not yet released and unstable.
```shell
git clone https://github.com/ory/oathkeeper.git

cd oathkeeper

go mod download

go install -tags sqlite,json1,hsm .

$(go env GOPATH)/bin/oathkeeper help
```

### Useful Links
- [Download Binaries](/content/docs/oathkeeper/install#download-binaries/index.html)
- [Building from Source](/content/docs/oathkeeper/install#building-from-source/index.html)

**Ory Network** 
The largest Identity and Access Management network in the world. So you can get back to building your business.