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 #212

Merged
merged 5 commits into from
Sep 12, 2024

Conversation

silentoplayz
Copy link
Contributor

@silentoplayz silentoplayz commented Sep 11, 2024

Environment Variable Updates

In this PR, I've made the following changes:

Removed:

  • Environment variables that were documented but not accessed:
ENABLE_LITELLM
LITELLM_PROXY_HOST
LITELLM_PROXY_PORT
PORT
RAG_WEB_SEARCH_DOMAIN_FILTER_LIST
http_proxy
https_proxy
no_proxy
  • Deprecated environment variables:
OLLAMA_API_BASE_URL
SEARCH_QUERY_PROMPT_LENGTH_THRESHOLD
  • Removed the LiteLLM section to avoid confusion.

Added:

  • New environment variables:
USER_PERMISSIONS_CHAT_EDITING
USER_PERMISSIONS_CHAT_TEMPORARY
ENABLE_ADMIN_CHAT_ACCESS
ENABLE_MESSAGE_RATING
DEFAULT_LOCALE
FUNCTIONS_DIR
FONTS_DIR
CORS_ALLOW_ORIGIN
CONTENT_EXTRACTION_ENGINE
TIKA_SERVER_URL
RAG_FILE_MAX_COUNT
RAG_FILE_MAX_SIZE
ENABLE_SEARCH_QUERY
SEARCHAPI_API_KEY
SEARCHAPI_ENGINE
AUDIO_TTS_API_KEY
AUDIO_TTS_SPLIT_ON
AUTOMATIC1111_API_AUTH
COMFYUI_WORKFLOW
TOOLS_DIR

Other Improvements:

  • Updated prompt templates
  • Rearranged environment variables in the documentation for better organization
  • Added missing environment variables that were previously undocumented

Special thanks to @cheahjs for contributing new environment variables and creating a script to scan for missing env vars in the documentation (PR #207).

@silentoplayz
Copy link
Contributor Author

silentoplayz commented Sep 11, 2024

I didn't realize I did duplicate work until after having submitted my own PR. My sincere apologies @cheahjs. To compensate for the mistake, I've taken the initiative to merge the missing pieces from @cheahjs' PR into mine, in the spirit of collaboration and efficiency. I hope this is okay with you, @cheahjs, and I appreciate your understanding.

@cheahjs
Copy link
Contributor

cheahjs commented Sep 11, 2024

The "Proxy Settings" section should be kept around - the _proxy env vars aren't directly used by Open WebUI, but things like AIOHTTP will respect them. They were added in response to discussion threads around making Open WebUI use proxies.

@cheahjs
Copy link
Contributor

cheahjs commented Sep 11, 2024

Same with PORT, it's not used in the Python codebase, but is used by the backend startup script to configure uvicorn: https://github.com/open-webui/open-webui/blob/main/backend/start.sh#L8.

These were added to the ignore list in my script because they were used outside of Open WebUI's Python configuration code.

@silentoplayz
Copy link
Contributor Author

silentoplayz commented Sep 11, 2024

Understood! Will fix these hiccups now. 👍🏼

Edit: Fixed (Reverted removal of these environment variables you've mentioned)!

@tjbck
Copy link
Contributor

tjbck commented Sep 11, 2024

Ready to be merged?

@silentoplayz
Copy link
Contributor Author

Ready to be merged?

Yes, it's ready.

@tjbck
Copy link
Contributor

tjbck commented Sep 12, 2024

Thanks!

@tjbck tjbck merged commit 8f70c6b into open-webui:main Sep 12, 2024
@silentoplayz silentoplayz deleted the silentoplayz-env-updates branch September 12, 2024 15:27
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