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

Add documentation for OIDC #17131

Merged
merged 7 commits into from
Nov 8, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion docs/development/development-environment/docker/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -466,7 +466,7 @@ Once the keycloak service is started and running, you can access the keycloak in
and login with initial username and password as `admin`.

Keycloak being an OpenID connect provider, we need to setup an OIDC integration for OpenProject.
[Setup OIDC (keycloak) integration for OpenProject](../../../installation-and-operations/misc/custom-openid-connect-providers/#keycloak)
[Setup OIDC (keycloak) integration for OpenProject](../../../system-admin-guide/authentication/openid-providers/)

Once the above setup is completed, In the root `docker-compose.override.yml` file, uncomment all the environment in `backend` service for keycloak and set the values according to configuration done in keycloak for OpenProject Integration.

Expand Down

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -46,8 +46,8 @@ We support all authentication providers that support the SAML and OpenID Connec

## Is it possible to use a custom SSO provider (e.g. Keycloak) with the Enterprise cloud edition?

It is possible to use Keycloak, but you can't configure it yourself at the moment as there's no user interface (UI) for custom SSO providers. We can set up the custom provider for you. Then you can access and edit it in the administration. You will be able to enter client ID and client secret via the OpenProject UI.
For context: The connection of custom SSO providers is also described [here](../../../installation-and-operations/misc/custom-openid-connect-providers/#custom-openid-connect-providers) (however, we would enter this configuration for your Enterprise cloud environment).
It is possible to use Keycloak, Okta, or other OpenID Connect providers with the user interface (UI) for custom SSO providers.
For context: The connection of custom SSO providers is also described [here](../openid-providers/).

## I want to connect AD and LDAP to OpenProject. Which attribute for authentication sources does OpenProject use?

Expand Down
298 changes: 232 additions & 66 deletions docs/system-admin-guide/authentication/openid-providers/README.md

Large diffs are not rendered by default.

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -14,19 +14,33 @@ def column_args(column)
end

def name
link = render(
Primer::Beta::Link.new(
href: url_for(action: :edit, id: provider.id),
font_weight: :bold,
mr: 1
)
) { provider.display_name }
if !provider.configured?
link.concat(
render(Primer::Beta::Label.new(scheme: :attention)) { I18n.t(:label_incomplete) }
)
concat(provider_name)
unless provider.configured?
concat(incomplete_label)
end
link
end

def provider_name
render(Primer::OpenProject::FlexLayout.new) do |layout|
layout.with_row do
render(
Primer::Beta::Link.new(
href: url_for(action: :edit, id: provider.id),
font_weight: :bold,
mr: 1
)
) { provider.display_name }
end
layout.with_row do
render(Primer::Beta::Text.new(font_size: :small, color: :subtle)) do
provider.callback_url
end
end
end
end

def incomplete_label
render(Primer::Beta::Label.new(scheme: :attention)) { I18n.t(:label_incomplete) }
end

def type
Expand Down