diff --git a/README.md b/README.md index f74a79033f..09669786fd 100644 --- a/README.md +++ b/README.md @@ -33,10 +33,13 @@ This service is under active development and may introduce breaking changes in f - [Installation](#installation) -- [Installation](#installation) + - [Installation](#installation) + - [Download binaries](#download-binaries) + - [Using Docker](#using-docker) + - [Building from source](#building-from-source) - [Ecosystem](#ecosystem) - [ORY Security Console: Administrative User Interface](#ory-security-console-administrative-user-interface) - - [ORY Hydra: OAuth2 & OpenID Connect Server](#ory-hydra-oauth2--openid-connect-server) + - [ORY Hydra: OAuth2 & OpenID Connect Server](#ory-hydra-oauth2-&-openid-connect-server) - [ORY Keto: Access Control Policies as a Server](#ory-keto-access-control-policies-as-a-server) - [Security](#security) - [Disclosing vulnerabilities](#disclosing-vulnerabilities) @@ -52,10 +55,48 @@ This service is under active development and may introduce breaking changes in f ## Installation -The easiest way to install ORY Oathkeeper is using the [Docker Hub Image](https://hub.docker.com/r/oryd/oathkeeper/): +There are various ways of installing ORY Oathkeeper on your system. + +### Download binaries + +The client and server **binaries are downloadable at [releases](https://github.com/ory/oathkeeper/releases)**. +There is currently no installer available. You have to add the ORY Oathkeeper binary to the PATH environment variable yourself or put +the binary in a location that is already in your path (`/usr/bin`, ...). +If you do not understand what that all of this means, ask in our [chat channel](https://www.ory.sh/chat). We are happy to help. + +### Using Docker +**Starting the host** is easiest with docker. The host process handles HTTP requests and is backed by a database. +Read how to install docker on [Linux](https://docs.docker.com/linux/), [OSX](https://docs.docker.com/mac/) or +[Windows](https://docs.docker.com/windows/). ORY Oathkeeper is available on [Docker Hub](https://hub.docker.com/r/oryd/oathkeeper/). + +You can use ORY Oathkeeper without a database, but be aware that restarting, scaling +or stopping the container will **lose all data**: + +``` +$ docker run -e "DATABASE_URL=memory" -d --name my-oathkeeper -p 4455:4455 -p 4456:4456 oryd/oathkeeper serve api +ec91228cb105db315553499c81918258f52cee9636ea2a4821bdb8226872f54b ``` -docker run oryd/oathkeeper: help + +### Building from source + +If you wish to compile ORY Oathkeeper yourself, you need to install and set up [Go 1.10+](https://golang.org/) and add `$GOPATH/bin` +to your `$PATH` as well as [golang/dep](http://github.com/golang/dep). + +The following commands will check out the latest release tag of ORY Oathkeeper and compile it and set up flags so that `oathkeeper version` +works as expected. Please note that this will only work with a linux shell like bash or sh. + +``` +go get -d -u github.com/ory/oathkeeper +cd $(go env GOPATH)/src/github.com/ory/oathkeeper +OATHKEEPER_LATEST=$(git describe --abbrev=0 --tags) +git checkout $OATHKEEPER_LATEST +dep ensure -vendor-only +go install \ + -ldflags "-X github.com/ory/oathkeeper/cmd.Version=$OATHKEEPER_LATEST -X github.com/ory/oathkeeper/cmd.BuildTime=`TZ=UTC date -u '+%Y-%m-%dT%H:%M:%SZ'` -X github.com/ory/oathkeeper/cmd.GitHash=`git rev-parse HEAD`" \ + github.com/ory/oathkeeper +git checkout master +oathkeeper help ``` ## Ecosystem @@ -114,7 +155,7 @@ Run `oathkeeper -h` or `oathkeeper help`. ### Develop -Developing with ORY Hydra is as easy as: +Developing with ORY Oathkeeper is as easy as: ``` go get -d -u github.com/ory/oathkeeper diff --git a/cmd/helper_messages.go b/cmd/helper_messages.go index e53c1bf638..36441eafbb 100644 --- a/cmd/helper_messages.go +++ b/cmd/helper_messages.go @@ -48,7 +48,7 @@ var corsMessage = `CORS CONTROLS - CORS_EXPOSED_HEADERS: Indicates which headers (comma separated values) are safe to expose to the API of a CORS API specification.` -var databaseUrl = `- DATABASE_URL: A URL to a persistent backend. Hydra supports various backends: +var databaseUrl = `- DATABASE_URL: A URL to a persistent backend. ORY Oathkeeper supports various backends: - Memory: If DATABASE_URL is "memory", data will be written to memory and is lost when you restart this instance. Example: DATABASE_URL=memory diff --git a/cmd/serve_proxy.go b/cmd/serve_proxy.go index 8f2af269c9..d0fb867c52 100644 --- a/cmd/serve_proxy.go +++ b/cmd/serve_proxy.go @@ -53,7 +53,7 @@ var proxyCmd = &cobra.Command{ This command exposes a variety of controls via environment variables. You can set environments using "export KEY=VALUE" (Linux/macOS) or "set KEY=VALUE" (Windows). On Linux, -you can also set environments by prepending key value pairs: "KEY=VALUE KEY2=VALUE2 hydra" +you can also set environments by prepending key value pairs: "KEY=VALUE KEY2=VALUE2 oathkeeper" All possible controls are listed below. diff --git a/docs/README.md b/docs/README.md index 0e9a758dc0..a94ba4439b 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,2 +1,2 @@ The documentation has moved to [another GitHub repository](https://github.com/ory/docs). Make changes to the -ORY Hydra user guide [here](https://github.com/ory/docs/tree/master/guides/2-oathkeeper). +ORY Oathkeeper user guide [here](https://github.com/ory/docs/tree/master/guides/2-oathkeeper). diff --git a/scripts/run-gensdk.sh b/scripts/run-gensdk.sh index 8a4faa9f71..86d8cc4273 100755 --- a/scripts/run-gensdk.sh +++ b/scripts/run-gensdk.sh @@ -6,7 +6,7 @@ cd "$( dirname "${BASH_SOURCE[0]}" )/.." scripts/run-genswag.sh -rm -rf ./sdk/go/hydra/swagger +rm -rf ./sdk/go/oathkeeper/swagger rm -rf ./sdk/js/swagger # curl -O scripts/swagger-codegen-cli-2.2.3.jar http://central.maven.org/maven2/io/swagger/swagger-codegen-cli/2.2.3/swagger-codegen-cli-2.2.3.jar