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 23, 2020
1 parent a9f770b commit f557c9a
Show file tree
Hide file tree
Showing 12 changed files with 187 additions and 190 deletions.
14 changes: 7 additions & 7 deletions docs/docs/configure-deploy.mdx
Expand Up @@ -78,11 +78,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.5.0-beta.2
$ docker pull oryd/hydra:v1.5.0-beta.3

# 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.5.0-beta.2 help serve
$ docker run -it --rm --entrypoint hydra oryd/hydra:v1.5.0-beta.3 help serve

Starts all HTTP/2 APIs and connects to a database backend.
[...]
Expand All @@ -92,7 +92,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.5.0-beta.2 \
oryd/hydra:v1.5.0-beta.3 \
migrate sql --yes $DSN

Applying `client` SQL migrations...
Expand All @@ -110,7 +110,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.5.0-beta.2 serve all
oryd/hydra:v1.5.0-beta.3 serve all

# And check if it's running:
$ docker logs ory-hydra-example--hydra
Expand Down Expand Up @@ -178,7 +178,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.5.0-beta.2 help
$ docker run --rm -it --entrypoint hydra oryd/hydra:v1.5.0-beta.3 help
Hydra is a cloud native high throughput OAuth2 and OpenID Connect provider

Usage:
Expand Down Expand Up @@ -237,7 +237,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.5.0-beta.2 \
oryd/hydra:v1.5.0-beta.3 \
clients create --skip-tls-verify \
--id facebook-photo-backup \
--secret some-secret \
Expand Down Expand Up @@ -284,7 +284,7 @@ for an access token. The same thing happens with this command:
$ docker run --rm -it \
--network hydraguide \
-p 9010:9010 \
oryd/hydra:v1.5.0-beta.2 \
oryd/hydra:v1.5.0-beta.3 \
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
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.5.0-beta.2
$ docker run --rm -it oryd/hydra:v1.5.0-beta.2 help
$ docker pull oryd/hydra:v1.5.0-beta.3
$ docker run --rm -it oryd/hydra:v1.5.0-beta.3 help
```

## macOS
Expand Down

0 comments on commit f557c9a

Please sign in to comment.