Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: quickstart next steps #676

Merged
merged 3 commits into from
Aug 31, 2020
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
33 changes: 33 additions & 0 deletions docs/docs/quickstart.mdx
Original file line number Diff line number Diff line change
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](https://www.ory.sh/kratos/docs/self-service/hooks/index/).
vinckr marked this conversation as resolved.
Show resolved Hide resolved

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](https://www.ory.sh/kratos/docs/guides/sign-in-with-github-google-facebook-linkedin)
vinckr marked this conversation as resolved.
Show resolved Hide resolved