Skip to content

Commit

Permalink
all: Resolves minor typos and updates install guide
Browse files Browse the repository at this point in the history
  • Loading branch information
arekkas committed Jun 3, 2018
1 parent b6b90e5 commit 3852be5
Show file tree
Hide file tree
Showing 7 changed files with 55 additions and 20 deletions.
55 changes: 48 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,11 +28,14 @@ a subject (user, application, service, car, ...) is authorized to perform a cert


- [Introduction](#introduction)
- [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 Oathkeeper: Identity & Access Proxy](#ory-oathkeeper-identity--access-proxy)
- [ORY Hydra: OAuth2 & OpenID Connect Server](#ory-hydra-oauth2-&-openid-connect-server)
- [ORY Oathkeeper: Identity & Access Proxy](#ory-oathkeeper-identity-&-access-proxy)
- [Security](#security)
- [Disclosing vulnerabilities](#disclosing-vulnerabilities)
- [Telemetry](#telemetry)
Expand All @@ -55,12 +58,50 @@ ORY Keto is possible to resolve credentials using various authentication mechani
* JSON Web Tokens (coming soon).
* SAML (coming soon).

## Installation
### Installation

The easiest way to install ORY Keto is using the [Docker Hub Image](https://hub.docker.com/r/oryd/keto/):
There are various ways of installing ORY keto on your system.

#### Download binaries

The client and server **binaries are downloadable at [releases](https://github.com/ory/keto/releases)**.
There is currently no installer available. You have to add the ORY keto 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 keto is available on [Docker Hub](https://hub.docker.com/r/oryd/keto/).

You can use ORY keto 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-keto -p 4455:4455 -p 4456:4456 oryd/keto serve api
ec91228cb105db315553499c81918258f52cee9636ea2a4821bdb8226872f54b
```

#### Building from source

If you wish to compile ORY keto 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 keto and compile it and set up flags so that `keto version`
works as expected. Please note that this will only work with a linux shell like bash or sh.

```
docker run oryd/keto:<version> help
go get -d -u github.com/ory/keto
cd $(go env GOPATH)/src/github.com/ory/keto
keto_LATEST=$(git describe --abbrev=0 --tags)
git checkout $keto_LATEST
dep ensure -vendor-only
go install \
-ldflags "-X github.com/ory/keto/cmd.Version=$keto_LATEST -X github.com/ory/keto/cmd.BuildTime=`TZ=UTC date -u '+%Y-%m-%dT%H:%M:%SZ'` -X github.com/ory/keto/cmd.GitHash=`git rev-parse HEAD`" \
github.com/ory/keto
git checkout master
keto help
```

## Ecosystem
Expand Down Expand Up @@ -95,7 +136,7 @@ and send us an email to [[email protected]](mailto:[email protected]) instead.
## Telemetry

Our services collect summarized, anonymized data which can optionally be turned off. Click
[here](https://www.ory.sh/docs/1-hydra/9-telemetry) to learn more.
[here](https://www.ory.sh/docs/guides/master/telemetry/) to learn more.

### Guide

Expand Down
2 changes: 1 addition & 1 deletion cmd/client/handler_policy.go
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ func (h *PolicyHandler) CreatePolicy(cmd *cobra.Command, args []string) {

if files, _ := cmd.Flags().GetStringSlice("files"); len(files) > 0 {
fmt.Println("Importing policies using the -f flag is deprecated and will be removed in the future.")
fmt.Println(`Please use "hydra policies import" instead.`)
fmt.Println(`Please use "keto policies import" instead.`)
h.ImportPolicy(cmd, files)
return
}
Expand Down
2 changes: 1 addition & 1 deletion cmd/policies_subjects_add.go
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ var policiesSubjectsAddCmd = &cobra.Command{
Long: `You can use regular expressions in your matches. Encapsulate them in < >.
Example:
keto policies subjects hydra add my-policy [email protected] <[peter|max]>@org.com`,
keto policies subjects add my-policy [email protected] <[peter|max]>@org.com`,
Run: cmdHandler.Policies.AddSubjectToPolicy,
}

Expand Down
6 changes: 3 additions & 3 deletions cmd/serve.go
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ the controls section.
CORE CONTROLS
=============
- DATABASE_URL: A URL to a persistent backend. Hydra supports various backends:
- DATABASE_URL: A URL to a persistent backend. ORY Keto 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
Expand All @@ -53,10 +53,10 @@ CORE CONTROLS
Be aware that the ?parseTime=true parameter is mandatory, or timestamps will not work.
- PORT: The port hydra should listen on.
- PORT: The port ORY Keto should listen on.
Defaults to PORT=4466
- HOST: The host interface hydra should listen on. Leave empty to listen on all interfaces.
- HOST: The host interface ORY Keto should listen on. Leave empty to listen on all interfaces.
Example: HOST=localhost
- LOG_LEVEL: Set the log level, supports "panic", "fatal", "error", "warn", "info" and "debug". Defaults to "info".
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "ory-keto-sdk",
"version": "0.0.0",
"description": "The official JavaScript / NodeJS SDK for ORY Hydra.",
"description": "The official JavaScript / NodeJS SDK for ORY Keto.",
"license": "Apache 2.0",
"main": "sdk/js/swagger/src/index.js",
"scripts": {
Expand Down
6 changes: 0 additions & 6 deletions policy/handler.go
Original file line number Diff line number Diff line change
Expand Up @@ -164,9 +164,6 @@ func (h *Handler) Get(w http.ResponseWriter, r *http.Request, ps httprouter.Para
//
// Schemes: http, https
//
// Security:
// oauth2: hydra.policies
//
// Responses:
// 204: emptyResponse
// 401: genericError
Expand Down Expand Up @@ -195,9 +192,6 @@ func (h *Handler) Delete(w http.ResponseWriter, r *http.Request, ps httprouter.P
//
// Schemes: http, https
//
// Security:
// oauth2: hydra.policies
//
// Responses:
// 200: policy
// 401: genericError
Expand Down
2 changes: 1 addition & 1 deletion sdk/go/keto/sdk.go
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ type CodeGenSDK struct {

// Configuration configures the CodeGenSDK.
type Configuration struct {
// EndpointURL should point to the url of ORY Hydra, for example: http://localhost:4444
// EndpointURL should point to the url of ORY Keto, for example: http://localhost:4466
EndpointURL string
}

Expand Down

0 comments on commit 3852be5

Please sign in to comment.