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

SAML documentation corrections #19162

Open
shawniverson opened this issue Dec 20, 2024 · 0 comments
Open

SAML documentation corrections #19162

shawniverson opened this issue Dec 20, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@shawniverson
Copy link

Is some content missing, wrong or not clear?

The documentation for the following fails to mention that the AUTHENTICATION_PROVIDER has to be set to saml (lowercase) before SAML will work.

https://docs.open-metadata.org/latest/deployment/security/saml/azure

On step 4, it states "Set up for SAML is done, you should be routed to your IDP on trying to Sign-in." This doesn't happen until AUTHENTICATION_PROVIDER is set to saml.

https://docs.open-metadata.org/latest/deployment/security/saml/docker

The title of this article is "Keycloak SSO for Docker" but this isn't necessarily about Keycloak, which is in a different section of the documentation.

SAML_IDP_CERTIFICATE=/path/to/the/certificate

Using a path for this doesn't appear to work had to pass the entire certificate here as a string instead of the path to the file. When using a path it tried to parse the path as a base64 encoded cert instead of the contents.

Describe the solution you'd like
Update the documentation to mention need for AUTHENTICATION_PROVIDER and that the SAML_IDP_CERTIFICATE either needs to actually support a path in the source code or be updated to pass the certificate in as a string instead of a path.

@shawniverson shawniverson added the documentation Improvements or additions to documentation label Dec 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant