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 Jan 29, 2021
1 parent f0580e2 commit 21c6285
Show file tree
Hide file tree
Showing 8 changed files with 29 additions and 29 deletions.
16 changes: 8 additions & 8 deletions docs/docs/configure-deploy.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -76,11 +76,11 @@ $ export SECRETS_SYSTEM=$(export LC_CTYPE=C; cat /dev/urandom | tr -dc 'a-zA-Z0-
$ export DSN=postgres://hydra:secret@ory-hydra-example--postgres:5432/hydra?sslmode=disable

# Before starting, let's pull the latest ORY Hydra tag from docker.
$ docker pull oryd/hydra:v1.9.1
$ docker pull oryd/hydra:v1.9.2

# This command will show you all the environment variables that you can set. Read this carefully.
# It is the equivalent to `hydra help serve`.
$ docker run -it --rm --entrypoint hydra oryd/hydra:v1.9.1 help serve
$ docker run -it --rm --entrypoint hydra oryd/hydra:v1.9.2 help serve

Starts all HTTP/2 APIs and connects to a database backend.
[...]
Expand All @@ -90,7 +90,7 @@ Starts all HTTP/2 APIs and connects to a database backend.
# It is the equivalent to `hydra migrate sql --yes postgres://hydra:secret@ory-hydra-example--postgres:5432/hydra?sslmode=disable`
$ docker run -it --rm \
--network hydraguide \
oryd/hydra:v1.9.1 \
oryd/hydra:v1.9.2 \
migrate sql --yes $DSN

Applying `client` SQL migrations...
Expand All @@ -108,7 +108,7 @@ $ docker run -d \
-e URLS_SELF_ISSUER=https://localhost:9000/ \
-e URLS_CONSENT=http://localhost:9020/consent \
-e URLS_LOGIN=http://localhost:9020/login \
oryd/hydra:v1.9.1 serve all
oryd/hydra:v1.9.2 serve all

# And check if it's running:
$ docker logs ory-hydra-example--hydra
Expand Down Expand Up @@ -159,7 +159,7 @@ mount it in the container. For example:
```shell
$ docker run -d \
-v $(pwd)/hydra.yaml:/hydra.yaml \
oryd/hydra:v1.9.1 serve all --config /hydra.yaml
oryd/hydra:v1.9.2 serve all --config /hydra.yaml
```

:::
Expand Down Expand Up @@ -194,7 +194,7 @@ ORY Hydra can be managed using the Hydra Command Line Interface (CLI), which is
using ORY Hydra's REST APIs. To see the available commands, run:

```shell
$ docker run --rm -it --entrypoint hydra oryd/hydra:v1.9.1 help
$ docker run --rm -it --entrypoint hydra oryd/hydra:v1.9.2 help
Hydra is a cloud native high throughput OAuth2 and OpenID Connect provider

Usage:
Expand Down Expand Up @@ -253,7 +253,7 @@ URLs the client may request:
$ docker run --rm -it \
-e HYDRA_ADMIN_URL=https://ory-hydra-example--hydra:4445 \
--network hydraguide \
oryd/hydra:v1.9.1 \
oryd/hydra:v1.9.2 \
clients create --skip-tls-verify \
--id facebook-photo-backup \
--secret some-secret \
Expand Down Expand Up @@ -300,7 +300,7 @@ for an access token. The same thing happens with this command:
$ docker run --rm -it \
--network hydraguide \
-p 9010:9010 \
oryd/hydra:v1.9.1 \
oryd/hydra:v1.9.2 \
token user --skip-tls-verify \
--port 9010 \
--auth-url https://localhost:9000/oauth2/auth \
Expand Down
4 changes: 2 additions & 2 deletions docs/docs/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ binaries, Docker Images and support various package managers.
We recommend using Docker to run ORY Hydra:

```shell
$ docker pull oryd/hydra:v1.9.1
$ docker run --rm -it oryd/hydra:v1.9.1 help
$ docker pull oryd/hydra:v1.9.2
$ docker run --rm -it oryd/hydra:v1.9.2 help
```

## macOS
Expand Down
16 changes: 8 additions & 8 deletions docs/versioned_docs/version-v1.9/configure-deploy.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -76,11 +76,11 @@ $ export SECRETS_SYSTEM=$(export LC_CTYPE=C; cat /dev/urandom | tr -dc 'a-zA-Z0-
$ export DSN=postgres://hydra:secret@ory-hydra-example--postgres:5432/hydra?sslmode=disable

# Before starting, let's pull the latest ORY Hydra tag from docker.
$ docker pull oryd/hydra:v1.9.1
$ docker pull oryd/hydra:v1.9.2

# This command will show you all the environment variables that you can set. Read this carefully.
# It is the equivalent to `hydra help serve`.
$ docker run -it --rm --entrypoint hydra oryd/hydra:v1.9.1 help serve
$ docker run -it --rm --entrypoint hydra oryd/hydra:v1.9.2 help serve

Starts all HTTP/2 APIs and connects to a database backend.
[...]
Expand All @@ -90,7 +90,7 @@ Starts all HTTP/2 APIs and connects to a database backend.
# It is the equivalent to `hydra migrate sql --yes postgres://hydra:secret@ory-hydra-example--postgres:5432/hydra?sslmode=disable`
$ docker run -it --rm \
--network hydraguide \
oryd/hydra:v1.9.1 \
oryd/hydra:v1.9.2 \
migrate sql --yes $DSN

Applying `client` SQL migrations...
Expand All @@ -108,7 +108,7 @@ $ docker run -d \
-e URLS_SELF_ISSUER=https://localhost:9000/ \
-e URLS_CONSENT=http://localhost:9020/consent \
-e URLS_LOGIN=http://localhost:9020/login \
oryd/hydra:v1.9.1 serve all
oryd/hydra:v1.9.2 serve all

# And check if it's running:
$ docker logs ory-hydra-example--hydra
Expand Down Expand Up @@ -159,7 +159,7 @@ mount it in the container. For example:
```shell
$ docker run -d \
-v $(pwd)/hydra.yaml:/hydra.yaml \
oryd/hydra:v1.9.1 serve all --config /hydra.yaml
oryd/hydra:v1.9.2 serve all --config /hydra.yaml
```

:::
Expand Down Expand Up @@ -194,7 +194,7 @@ ORY Hydra can be managed using the Hydra Command Line Interface (CLI), which is
using ORY Hydra's REST APIs. To see the available commands, run:

```shell
$ docker run --rm -it --entrypoint hydra oryd/hydra:v1.9.1 help
$ docker run --rm -it --entrypoint hydra oryd/hydra:v1.9.2 help
Hydra is a cloud native high throughput OAuth2 and OpenID Connect provider

Usage:
Expand Down Expand Up @@ -253,7 +253,7 @@ URLs the client may request:
$ docker run --rm -it \
-e HYDRA_ADMIN_URL=https://ory-hydra-example--hydra:4445 \
--network hydraguide \
oryd/hydra:v1.9.1 \
oryd/hydra:v1.9.2 \
clients create --skip-tls-verify \
--id facebook-photo-backup \
--secret some-secret \
Expand Down Expand Up @@ -300,7 +300,7 @@ for an access token. The same thing happens with this command:
$ docker run --rm -it \
--network hydraguide \
-p 9010:9010 \
oryd/hydra:v1.9.1 \
oryd/hydra:v1.9.2 \
token user --skip-tls-verify \
--port 9010 \
--auth-url https://localhost:9000/oauth2/auth \
Expand Down
4 changes: 2 additions & 2 deletions docs/versioned_docs/version-v1.9/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ binaries, Docker Images and support various package managers.
We recommend using Docker to run ORY Hydra:

```shell
$ docker pull oryd/hydra:v1.9.1
$ docker run --rm -it oryd/hydra:v1.9.1 help
$ docker pull oryd/hydra:v1.9.2
$ docker run --rm -it oryd/hydra:v1.9.2 help
```

## macOS
Expand Down
4 changes: 2 additions & 2 deletions quickstart-cockroach.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,12 @@ version: '3.7'

services:
hydra-migrate:
image: oryd/hydra:v1.9.1
image: oryd/hydra:v1.9.2
environment:
- DSN=cockroach://root@cockroachd:26257/defaultdb?sslmode=disable&max_conns=20&max_idle_conns=4

hydra:
image: oryd/hydra:v1.9.1
image: oryd/hydra:v1.9.2
environment:
- DSN=cockroach://root@cockroachd:26257/defaultdb?sslmode=disable&max_conns=20&max_idle_conns=4

Expand Down
4 changes: 2 additions & 2 deletions quickstart-mysql.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,12 +15,12 @@ version: '3.7'
services:

hydra-migrate:
image: oryd/hydra:v1.9.1
image: oryd/hydra:v1.9.2
environment:
- DSN=mysql://root:secret@tcp(mysqld:3306)/mysql?max_conns=20&max_idle_conns=4

hydra:
image: oryd/hydra:v1.9.1
image: oryd/hydra:v1.9.2
environment:
- DSN=mysql://root:secret@tcp(mysqld:3306)/mysql?max_conns=20&max_idle_conns=4

Expand Down
4 changes: 2 additions & 2 deletions quickstart-postgres.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,12 +15,12 @@ version: '3.7'
services:

hydra-migrate:
image: oryd/hydra:v1.9.1
image: oryd/hydra:v1.9.2
environment:
- DSN=postgres://hydra:secret@postgresd:5432/hydra?sslmode=disable&max_conns=20&max_idle_conns=4

hydra:
image: oryd/hydra:v1.9.1
image: oryd/hydra:v1.9.2
environment:
- DSN=postgres://hydra:secret@postgresd:5432/hydra?sslmode=disable&max_conns=20&max_idle_conns=4

Expand Down
6 changes: 3 additions & 3 deletions quickstart.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ version: '3.7'
services:

hydra:
image: oryd/hydra:v1.9.1-sqlite
image: oryd/hydra:v1.9.2-sqlite
ports:
- "4444:4444" # Public port
- "4445:4445" # Admin port
Expand All @@ -41,7 +41,7 @@ services:
- intranet

hydra-migrate:
image: oryd/hydra:v1.9.1-sqlite
image: oryd/hydra:v1.9.2-sqlite
environment:
- DSN=sqlite:///var/lib/sqlite/db.sqlite?_fk=true
command:
Expand All @@ -63,7 +63,7 @@ services:
consent:
environment:
- HYDRA_ADMIN_URL=http://hydra:4445
image: oryd/hydra-login-consent-node:v1.9.1
image: oryd/hydra-login-consent-node:v1.9.2
ports:
- "3000:3000"
restart: unless-stopped
Expand Down

0 comments on commit 21c6285

Please sign in to comment.