Skip to main content

Installation

danger

The APIs of Ory open-source Servers don't come with integrated access control. This means that all requests sent to their APIs are considered authenticated, authorized, and will be executed. Leaving the APIs in this state can lead to severe security risks.

When deploying Ory open-source Servers, protect access to their APIs using Ory Oathkeeper or a comparable API Gateway.

If you need help, reach out to the community on Ory Community Slack.

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

Ory provides pre-built binaries, Docker Images and support various package managers:

Linux​

Install Ory Kratos on Linux using bash <(curl ...):

bash <(curl https://raw.githubusercontent.com/ory/meta/master/install.sh) -d -b . kratos <version-you-want>
./kratos help

You may want to move Ory Kratos to your $PATH:

sudo mv ./kratos /usr/local/bin/
kratos help

macOS​

Install Ory Kratos using homebrew on macOS:

brew install ory/tap/kratos
ory help

Windows​

Install Ory Kratos on Windows using Scoop:

scoop bucket add ory https://github.com/ory/scoop.git
scoop install kratos
kratos help

Docker​

Ory Kratos is available as a Docker Image for all major platforms (ARM64, AMD64, ...):

docker pull oryd/kratos:<version-you-want>
docker run --rm -it oryd/kratos:<version-you-want> help

Kubernetes​

A list of available Helm Charts for Kubernetes can be found at k8s.ory.sh/helm.

Download Binaries​

You can download the client and server binaries on our Github 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:

kratos help

Building from source​

If you wish to compile the binary yourself, you need to install and set up Go 1.17+ and add $GOPATH/bin to your $PATH.

danger

Please note that this will check out the latest commit, which might be not yet released and unstable.

git clone https://github.com/ory/kratos.git
cd kratos
go mod download
go install -tags sqlite,json1,hsm .
$(go env GOPATH)/bin/kratos help