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

Update env-configuration.md #343

Merged
merged 13 commits into from
Dec 29, 2024
Merged

Conversation

silentoplayz
Copy link
Collaborator

@silentoplayz silentoplayz commented Dec 26, 2024

Update Open WebUI's list of environment variables (v0.3.20 -> v0.5.11). My apologies for the two separate initial commits rather than one to help compare side-by-side. I'm still learning GitHub Desktop.

This PR adds environment variables accessed by Open WebUI, but were not previously documented. I also tried to sort the environment variables the best I could, so there's a bunch of new categories.

Future improvements to Open WebUI's list of environment variables can include:

  • Distinguishing between persistent and non-persistent environment variables.
  • Listing available options (Sorta Hard) and default values (should mostly be complete) for restricted environment variables where necessary.
  • Identifying incompatible variable combinations and provide warnings or notes. (Hard)
  • Reviewing each environment variable and fixing any misinformation to improve correctness. (Also Hard)

Before:
image

After:
image

update for v0.4.8 list of env vars
Copy link
Collaborator

@0xThresh 0xThresh left a comment

Choose a reason for hiding this comment

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

Thank you for such a great effort on getting the docs updated!

@silentoplayz
Copy link
Collaborator Author

Is this ready to be merged? In the future, I believe the env list page could be updated if necessary. This already is a huge bump to the details on the page.

@tjbck tjbck merged commit fca1c02 into open-webui:main Dec 29, 2024
1 check passed
@silentoplayz silentoplayz deleted the update-env-doc branch December 29, 2024 05:19
danielrosehill pushed a commit to danielrosehill/openwebui-docs that referenced this pull request Mar 2, 2025
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