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 Oct 27, 2020
1 parent e1ff24a commit 1829042
Show file tree
Hide file tree
Showing 15 changed files with 202 additions and 154 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Clone the ORY Kratos repository and fetch the latest images:
```shell script
git clone https://github.com/ory/kratos.git
cd kratos
git checkout v0.5.2-alpha.1
git checkout v0.5.3-alpha.1

docker pull oryd/kratos:latest-sqlite
docker pull oryd/kratos-selfservice-ui-node:latest
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,7 +11,7 @@ binaries, Docker images, and support various package managers.
We recommend using Docker to run ORY Kratos:

```shell
$ docker pull oryd/kratos:v0.5.2-alpha.1
$ docker pull oryd/kratos:v0.5.3-alpha.1
$ docker run --rm -it oryd/kratos help
```

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

```shell
$ bash <(curl https://raw.githubusercontent.com/ory/kratos/v0.5.2-alpha.1/install.sh) -b . v0.5.2-alpha.1
$ bash <(curl https://raw.githubusercontent.com/ory/kratos/v0.5.3-alpha.1/install.sh) -b . v0.5.3-alpha.1
$ ./kratos help
```

Expand Down
14 changes: 7 additions & 7 deletions docs/docs/quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,7 @@ Let's clone ORY Kratos and run `docker-compose`:
```shell script
git clone https://github.com/ory/kratos.git
cd kratos
git checkout v0.5.2-alpha.1
git checkout v0.5.3-alpha.1

docker pull oryd/kratos:latest-sqlite
docker pull oryd/kratos-selfservice-ui-node:latest
Expand Down Expand Up @@ -444,23 +444,23 @@ recovery, head over to the
#### Configuration

You can find all configuration files used for this quickstart guide in
[`./contrib/quickstart/kratos`](https://github.com/ory/kratos/tree/v0.5.2-alpha.1/contrib/quickstart/kratos/email-password)
[`./contrib/quickstart/kratos`](https://github.com/ory/kratos/tree/v0.5.3-alpha.1/contrib/quickstart/kratos/email-password)
,
[`./quickstart.yml`](https://github.com/ory/kratos/blob/v0.5.2-alpha.1/quickstart.yml),
[`./quickstart.yml`](https://github.com/ory/kratos/blob/v0.5.3-alpha.1/quickstart.yml),
and
[`./quickstart-standalone.yml`](https://github.com/ory/kratos/blob/v0.5.2-alpha.1/quickstart-standalone.yml).
[`./quickstart-standalone.yml`](https://github.com/ory/kratos/blob/v0.5.3-alpha.1/quickstart-standalone.yml).
To understand what each of those configuration files does, consult the other
chapters of this documentation.

:::note

To get a minimal version of ORY Kratos running, you need to set configuration
values for
[`identity.default_schema_url`](https://github.com/ory/kratos/blob/v0.5.2-alpha.1/contrib/quickstart/kratos/email-password/.kratos.yml#L67)
[`identity.default_schema_url`](https://github.com/ory/kratos/blob/v0.5.3-alpha.1/contrib/quickstart/kratos/email-password/.kratos.yml#L67)
and
[`DSN`](https://github.com/ory/kratos/blob/v0.5.2-alpha.1/quickstart.yml#L42).
[`DSN`](https://github.com/ory/kratos/blob/v0.5.3-alpha.1/quickstart.yml#L42).
You should also configure
[`selfservice.flows.*.ui_url`](https://github.com/ory/kratos/blob/v0.5.2-alpha.1/contrib/quickstart/kratos/email-password/.kratos.yml#L40)
[`selfservice.flows.*.ui_url`](https://github.com/ory/kratos/blob/v0.5.3-alpha.1/contrib/quickstart/kratos/email-password/.kratos.yml#L40)
or else Kratos will use fallback URLs.

:::
Expand Down

0 comments on commit 1829042

Please sign in to comment.