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.

Sign up for GitHub

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

chore: add keycloak to auth docs; vale fixes #137

Merged
merged 1 commit into from
Oct 23, 2023
Merged

chore: add keycloak to auth docs; vale fixes #137

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions .vale/styles/Flipt/spelling-exceptions.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
affordance
APIs
auditable
backoff
boolean
caddy
codeowners
codespaces
config
darwin
datetime
declaratively
Expand All @@ -17,13 +19,15 @@ flipt
flipt's
Gitlab
grafana
grpc
hostname
http
httplug
https
javascript
jq
json
keycloak
linux
memcached
Minio
Expand Down
1 change: 1 addition & 0 deletions authentication/methods.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,7 @@ Numerous OIDC providers are available. For example, we've tested Flipt with:
- Dex
- Okta
- AzureAD
- Keycloak

Each provider has their own way of establishing clients and acquiring the relevant credentials.
You can find further documentation on leveraging providers like these in our [OIDC Configuration](/configuration/authentication#method-oidc) documentation.
Expand Down
6 changes: 3 additions & 3 deletions configuration/authentication.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -138,8 +138,7 @@ authentication:
- profile
```

Multiple providers can be configured simultaneously.
Each will result in a Login option being presented in the UI, along with a separate endpoint being added in the API to support each provider flow.
Multiple providers can be configured simultaneously. Each provider will result in a login option being presented in the UI, along with a configured endpoint to support the provider flow.

!["OIDC Login"](../images/configuration/oidc_login.png)

Expand All @@ -151,8 +150,9 @@ Flipt has been tested with each of the following providers:
- [Dex](https://dexidp.io/docs/openid-connect/)
- [Okta](https://developer.okta.com/docs/concepts/oauth-openid/#oauth-2-0)
- [AzureAD](https://docs.microsoft.com/en-us/azure/active-directory/develop/v2-protocols-oidc)
- [Keycloak](https://www.keycloak.org/docs/latest/server_admin/index.html#_identity_broker_oidc)

Though the intention is that it should work with other OIDC providers, these are just the handful the Flipt team has validated.
Though the intention is that it should work with all OIDC providers, these are just the handful the Flipt team has validated.

Following any of the links above should take you to the relevant documentation for each of these providers' OIDC client setups.
You can use the credentials and client configuration obtained using those steps as configuration for your Flipt instance.
Expand Down