Skip to content

Commit

Permalink
autogen(docs): generate and format documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
aeneasr committed May 7, 2020
1 parent 5b14a63 commit 7a6904f
Show file tree
Hide file tree
Showing 21 changed files with 7,423 additions and 219 deletions.
30 changes: 19 additions & 11 deletions docs/docs/configure-deploy.md
Original file line number Diff line number Diff line change
Expand Up @@ -236,7 +236,7 @@ HS256, ...). Let's generate a key for the RS256 algorithm that will be used by
the id_token mutator:

```sh
$ docker run oryd/oathkeeper:v0.37.1-beta.1 credentials generate --alg RS256 > jwks.json
$ docker run oryd/oathkeeper:v0.38.0-beta.1 credentials generate --alg RS256 > jwks.json
```

### Dockerfile
Expand All @@ -246,7 +246,7 @@ files to the image:

```shell
$ cat << EOF > Dockerfile
FROM oryd/oathkeeper:v0.37.1-beta.1
FROM oryd/oathkeeper:v0.38.0-beta.1
ADD config.yaml /config.yaml
ADD rules.json /rules.json
Expand All @@ -268,7 +268,7 @@ Before building the Docker Image, we need to make sure that the local ORY
Oathkeeper Docker Image is on the most recent version:

```sh
$ docker pull oryd/oathkeeper:v0.37.1-beta.1
$ docker pull oryd/oathkeeper:v0.38.0-beta.1
```

Next we will build our custom Docker Image
Expand Down Expand Up @@ -374,11 +374,12 @@ $ rm -rf oathkeeper-demo

## Monitoring

Oathkeeper provides an endpoint for Prometheus to scrape as a target. This endpoint can
be accessed by default at:
Oathkeeper provides an endpoint for Prometheus to scrape as a target. This
endpoint can be accessed by default at:
[http://localhost:9000/metrics](http://localhost:9000/metrics):

You can adjust the settings within Oathkeeper's config.

```shell
$ cat << EOF > config.yaml
serve:
Expand All @@ -389,8 +390,10 @@ serve:
EOF
```

Prometheus can easily be run as a docker container. More information are available on [https://github.com/prometheus/prometheus](https://github.com/prometheus/prometheus). Start with setting up a prometheus configuration:

Prometheus can easily be run as a docker container. More information are
available on
[https://github.com/prometheus/prometheus](https://github.com/prometheus/prometheus).
Start with setting up a prometheus configuration:

```shell
$ cat << EOF > prometheus.yml
Expand All @@ -410,22 +413,27 @@ scrape_configs:
- targets: ['localhost:9000']
```
Then start the prometheus server and access it on [http://localhost:9090](http://localhost:9090).
Then start the prometheus server and access it on
[http://localhost:9090](http://localhost:9090).
```shell
$ docker run \
--config.file=/etc/prometheus/prometheus.yml \
-v ./prometheus.yml:/etc/prometheus/prometheus.yml \
--name prometheus \
-d \
-d \
--net=host
-p 9090:9090 \
prom/prometheus
```
Now where you have a basic monitoring setup running you can extend it by building up nice visualizations eg. using Grafana. More information are available on [https://prometheus.io/docs/visualization/grafana/](https://prometheus.io/docs/visualization/grafana/).
Now where you have a basic monitoring setup running you can extend it by
building up nice visualizations eg. using Grafana. More information are
available on
[https://prometheus.io/docs/visualization/grafana/](https://prometheus.io/docs/visualization/grafana/).
We have a pre built Dashboard which you can use to get started quickly:
[Oathkeeper-Dashboard.json](https://github.com/ory/oathkeeper/tree/master/contrib/grafana/Oathkeeper-Dashboard.json).
<img alt="ORY Oathkeeper with Prometheus and Grafana" src={useBaseUrl('img/docs/grafana.png')} />
<img alt="ORY Oathkeeper with Prometheus and Grafana"
src={useBaseUrl('img/docs/grafana.png')} />
4 changes: 2 additions & 2 deletions docs/docs/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ pre-built binaries, Docker Images and support various package managers.
We recommend using Docker to run ORY Oathkeeper:

```shell
$ docker pull oryd/oathkeeper:v0.37.1-beta.1
$ docker pull oryd/oathkeeper:v0.38.0-beta.1
$ docker run --rm -it oryd/oathkeeper help
```

Expand All @@ -31,7 +31,7 @@ On linux, you can use `bash <(curl ...)` to fetch the latest stable binary
using:

```shell
$ bash <(curl https://raw.githubusercontent.com/ory/oathkeeper/master/install.sh) -b . v0.37.1-beta.1
$ bash <(curl https://raw.githubusercontent.com/ory/oathkeeper/master/install.sh) -b . v0.38.0-beta.1
$ ./oathkeeper help
```

Expand Down
6 changes: 4 additions & 2 deletions docs/docs/pipeline/authn.md
Original file line number Diff line number Diff line change
Expand Up @@ -480,8 +480,10 @@ was granted the requested scope.
- `introspection_request_headers` (object, optional) - Additional headers to add
to the introspection request
- `cache` (object, optional) - Enables caching of incoming tokens
- `enabled` (bool, optional) - Enable the cache, will use exp time of token to determine when to evict from cache. Defaults to false.
- `ttl` (string) - Can override the default behaviour of using the token exp time, and specify a set time to live for the token in the cache.
- `enabled` (bool, optional) - Enable the cache, will use exp time of token to
determine when to evict from cache. Defaults to false.
- `ttl` (string) - Can override the default behaviour of using the token exp
time, and specify a set time to live for the token in the cache.

```yaml
# Global configuration file oathkeeper.yml
Expand Down
Loading

0 comments on commit 7a6904f

Please sign in to comment.