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: add guidelines about environment variables #266

Merged
merged 1 commit into from
Nov 2, 2022

Conversation

alexandrebrg
Copy link
Contributor

Add a brief note about configuration overrides through environment variables.

Description

In version v0.1.6, a feature created the ability to override configuration files options through environment variables. It's something very useful to know when deploying OpenFGA, and there isn't any reference yet in the documentation about it.

This PR adds a simple note in the configuration section to tell people that it's possible to use environment variables.

References

There is no references.

Review Checklist

  • I have clicked on "allow edits by maintainers".
  • I have added documentation for new/changed functionality in this PR or in a PR to openfga.dev [Provide a link to any relevant PRs in the references section above]
  • The correct base branch is being used, if not main
  • I have added tests to validate that the change in functionality is working as expected

@alexandrebrg alexandrebrg requested a review from a team as a code owner November 2, 2022 16:42
@CLAassistant
Copy link

CLAassistant commented Nov 2, 2022

CLA assistant check
All committers have signed the CLA.

@rhamzeh
Copy link
Member

rhamzeh commented Nov 2, 2022

Added a ticket of what we would like to do: #267

But until we get there, your PR adds a lot of value to anyone reading the docs, thanks @alexandrebrg !

@rhamzeh rhamzeh merged commit 20610f6 into openfga:main Nov 2, 2022
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