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

OIDC and SAML environment variables #1527

Merged
merged 1 commit into from
Mar 25, 2025
Merged

OIDC and SAML environment variables #1527

merged 1 commit into from
Mar 25, 2025

Conversation

Varamil
Copy link
Contributor

@Varamil Varamil commented Mar 19, 2025

Added reference to all environment variables linked to OpenID and SAML configuration with a link to the documentation

Context

After a discussion on Grist Community forum, it has been suggested to update the list of environment variables.

Proposed solution

All environment variables linked to OpenID and SAML are missing in the readme file, I propose to add two lines referencing prefix GRIST_OIDC and GRIST_SAML respectively, and provide a link to the complete documentation with the full list for each.

Related issues

None

Has this been tested?

  • 👍 yes, I added tests to the test suite
  • 💭 no, because this PR is a draft and still needs work
  • 🙅 no, because this is not relevant here (update of readme file)
  • 🙋 no, because I need help

Added reference to all environment variables linked to OpenID and SAML configuration with a link to the documentation
Copy link
Collaborator

@fflorent fflorent left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

First of all, thank you for your contribution and for taking care of this issue!

I agree that it would be more comfortable to mention the existence of the OIDC and SAML env variables in the README page.

I see that there exist sections for these variables: https://github.com/gristlabs/grist-core/blob/main/README.md#database-variables

I tend to think that:

  • it could be more convenient to have these variables documented in a separate section dedicated to the authentication
  • and like you just do, place links to the support website

What do you think?

Copy link
Member

@paulfitz paulfitz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks a lot @Varamil !

@paulfitz paulfitz merged commit a2489e0 into gristlabs:main Mar 25, 2025
22 of 23 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants