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 Jul 14, 2021
1 parent 30b77e6 commit 379f34a
Show file tree
Hide file tree
Showing 157 changed files with 4,934 additions and 12,909 deletions.
6 changes: 1 addition & 5 deletions docs/docs/.static/api.json
Original file line number Diff line number Diff line change
Expand Up @@ -699,7 +699,7 @@
"get": {
"description": "```\nmetadata:\nannotations:\nprometheus.io/port: \"4434\"\nprometheus.io/path: \"/metrics/prometheus\"\n```",
"produces": ["plain/text"],
"tags": ["admin"],
"tags": ["metadata"],
"summary": "Get snapshot metrics from the service. If you're using k8s, you can then add annotations to\nyour deployment like so:",
"operationId": "prometheus",
"responses": {
Expand Down Expand Up @@ -1824,10 +1824,6 @@
"type": "object",
"required": ["Socket", "Types"],
"properties": {
"ProtocolScheme": {
"description": "Protocol to use for clients connecting to the plugin.",
"type": "string"
},
"Socket": {
"description": "socket",
"type": "string"
Expand Down
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.10.2
$ docker pull oryd/hydra:v1.10.3-pre.1

# 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.10.2 help serve
$ docker run -it --rm --entrypoint hydra oryd/hydra:v1.10.3-pre.1 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.10.2 \
oryd/hydra:v1.10.3-pre.1 \
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.10.2 serve all
oryd/hydra:v1.10.3-pre.1 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.10.2 serve all --config /hydra.yaml
oryd/hydra:v1.10.3-pre.1 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.10.2 help
$ docker run --rm -it --entrypoint hydra oryd/hydra:v1.10.3-pre.1 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.10.2 \
oryd/hydra:v1.10.3-pre.1 \
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.10.2 \
oryd/hydra:v1.10.3-pre.1 \
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.10.2
$ docker run --rm -it oryd/hydra:v1.10.2 help
$ docker pull oryd/hydra:v1.10.3-pre.1
$ docker run --rm -it oryd/hydra:v1.10.3-pre.1 help
```

## macOS
Expand Down
Loading

0 comments on commit 379f34a

Please sign in to comment.