Skip to content

Commit

Permalink
docs: quickstart next steps (#676)
Browse files Browse the repository at this point in the history
Added a section outlining some easy config changes, that users can apply to the quickstart to test out different scenarios and configurations.
  • Loading branch information
vinckr committed Aug 31, 2020
1 parent d5f1a8b commit ee9dd0d
Showing 1 changed file with 33 additions and 0 deletions.
33 changes: 33 additions & 0 deletions docs/docs/quickstart.mdx
Expand Up @@ -613,3 +613,36 @@ and remove all mounted volumes.
docker-compose -f quickstart.yml down -v
docker-compose -f quickstart.yml rm -fsv
```

## Next Steps

Here is some information if you want to modify the quickstart to test ORY Kratos in with different settings.

__Using different databases__

If you want to run the quickstart with PostgreSQL, run the following docker-compose:
`docker-compose -f quickstart.yml -f quickstart-standalone.yml -f quickstart-postgres.yml up --build --force-recreate`

If you want to run the quickstart with CockroachDB, run the following docker-compose:
`docker-compose -f quickstart.yml -f quickstart-standalone.yml -f quickstart-crdb.yml up --build --force-recreate`

If you want to run the quickstart with MySQL, run the following docker-compose:
`docker-compose -f quickstart.yml -f quickstart-standalone.yml -f quickstart-mysql.yml up --build --force-recreate`

__Changing ports__

If you want to change ports for the SelfService-UI, you need to change them in `quickstart.yml` as well as in the `contrib/quickstart/kratos/email-password/.kratos.yml` accordingly.

Note that you also need to change the ports for flows (error, settings, recovery, verification, logout, login, registration).

The same procedure applies if you want to change ports for the Public UI/Admin UI or the Mailslurper.

__Hooks__

If you want to change the redirects happening after registration,login or a settings change, take a look at this document: [Hooks](self-service/hooks/index).

If you delete the `session` hook from `kratos.yml`, the user will _not_ be immediately signed in after registration.

__OIDC__

If you want to test ORY Kratos integration with different OIDC providers, you will find more information in this document: [OIDC](guides/sign-in-with-github-google-facebook-linkedin)

0 comments on commit ee9dd0d

Please sign in to comment.