[PR #1396] [MERGED] docs: document the env variables the code reads but the reference page did not list #1359

New issue

Closed

opened 2026-10-18 14:19:07 +00:00 by bsakaguchi · 0 comments

bsakaguchi commented

2026-10-18 14:19:07 +00:00

Owner

📋 Pull Request Information

Original PR: https://github.com/open-webui/docs/pull/1396
Author: @silentoplayz
Created: 9/18/2026
Status: ✅ Merged
Merged: 9/18/2026
Merged by: @silentoplayz

Base: main ← Head: docs/env-missing

📝 Commits (1)

904a674 docs: document the env variables the code reads but the reference page did not list

📊 Changes

1 file changed (+195 additions, -0 deletions)

View changed files

📝 docs/reference/env-configuration.mdx (+195 -0)

📄 Description

Summary

I listed every os.getenv and os.environ.get name in backend/open_webui on dev and checked each against the environment variable reference. These are read by the code but had no entry on the page. Each one now has an entry with its type, default, and what the code does with it, placed in the section its neighbors live in:

Content extraction: the eleven DATALAB_MARKER_* settings and MINERU_API_MODE, MINERU_API_URL, MINERU_API_KEY. The Datalab entries say which Marker request field each one sends, with the meanings from Datalab's API reference, and note that Open WebUI posts to the /marker endpoint, which that reference now marks as deprecated in favor of /convert.
OAuth: OAUTH_UPDATE_NAME_ON_LOGIN, OAUTH_UPDATE_EMAIL_ON_LOGIN (including the skip when the new address is already taken), OAUTH_CLIENT_TIMEOUT, and OAUTH_ACCESS_TOKEN_REQUEST_INCLUDE_CLIENT_ID.
General: DEPLOYMENT_ID (returned by GET /api/version), INSTANCE_ID (stamped on every event envelope), WEBUI_AUTH_SIGNOUT_REDIRECT_URL, THREAD_POOL_THREAD_NAME_PREFIX, USE_SLIM_DOCKER and the four things it changes, LICENSE_BLOB_PATH, LICENSE_PUBLIC_KEY.
Web search and images: TAVILY_API_BASE_URL, and GEMINI_API_BASE_URL and GEMINI_API_KEY, which the page already referenced as fallbacks without defining.
Evaluation: AUXILIARY_EMBEDDING_MODEL, the SentenceTransformers model behind the leaderboard's query filter.

Three names were left out on purpose because nothing reads them at runtime: OAUTH_TIMEOUT and OAUTH_TOKEN_ENDPOINT_AUTH_METHOD are stored but never consumed, and TRUSTED_SIGNATURE_KEY feeds a helper no code calls.

None. Follow-up to #1395.

Checklist

I have reviewed the relevant documentation and matched the existing style.
This PR meets Open WebUI's contribution standards: it is accurate, relevant to users, narrowly scoped, maintainable, and not promotional content, advertising, lead generation, SEO placement, or a request to list a product, service, provider, integration, gateway, tool, or company primarily for visibility.
I understand that PRs that do not meet these standards may be closed without review and will not be merged. Repeated, low-quality, off-topic, promotional, or intentionally misleading submissions may result in the contributor being blocked from future participation in Open WebUI repositories.

Notes for reviewers

Defaults and behavior come from config.py, env.py, utils/oauth.py, routers/auths.py, routers/evaluations.py, events.py, main.py, and the Datalab and MinerU loaders on dev. The Datalab field meanings come from Datalab's /convert API reference where it lists them. Additions only, no existing entry changed, so every existing anchor still resolves.

_{🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.}

## 📋 Pull Request Information **Original PR:** https://github.com/open-webui/docs/pull/1396 **Author:** [@silentoplayz](https://github.com/silentoplayz) **Created:** 9/18/2026 **Status:** ✅ Merged **Merged:** 9/18/2026 **Merged by:** [@silentoplayz](https://github.com/silentoplayz) **Base:** `main` ← **Head:** `docs/env-missing` --- ### 📝 Commits (1) - [`904a674`](https://github.com/open-webui/docs/commit/904a6747e29d5d61319cf66e0705335595102b34) docs: document the env variables the code reads but the reference page did not list ### 📊 Changes **1 file changed** (+195 additions, -0 deletions) <details> <summary>View changed files</summary> 📝 `docs/reference/env-configuration.mdx` (+195 -0) </details> ### 📄 Description ## Summary I listed every `os.getenv` and `os.environ.get` name in `backend/open_webui` on `dev` and checked each against the environment variable reference. These are read by the code but had no entry on the page. Each one now has an entry with its type, default, and what the code does with it, placed in the section its neighbors live in: - **Content extraction:** the eleven `DATALAB_MARKER_*` settings and `MINERU_API_MODE`, `MINERU_API_URL`, `MINERU_API_KEY`. The Datalab entries say which Marker request field each one sends, with the meanings from Datalab's API reference, and note that Open WebUI posts to the `/marker` endpoint, which that reference now marks as deprecated in favor of `/convert`. - **OAuth:** `OAUTH_UPDATE_NAME_ON_LOGIN`, `OAUTH_UPDATE_EMAIL_ON_LOGIN` (including the skip when the new address is already taken), `OAUTH_CLIENT_TIMEOUT`, and `OAUTH_ACCESS_TOKEN_REQUEST_INCLUDE_CLIENT_ID`. - **General:** `DEPLOYMENT_ID` (returned by `GET /api/version`), `INSTANCE_ID` (stamped on every event envelope), `WEBUI_AUTH_SIGNOUT_REDIRECT_URL`, `THREAD_POOL_THREAD_NAME_PREFIX`, `USE_SLIM_DOCKER` and the four things it changes, `LICENSE_BLOB_PATH`, `LICENSE_PUBLIC_KEY`. - **Web search and images:** `TAVILY_API_BASE_URL`, and `GEMINI_API_BASE_URL` and `GEMINI_API_KEY`, which the page already referenced as fallbacks without defining. - **Evaluation:** `AUXILIARY_EMBEDDING_MODEL`, the SentenceTransformers model behind the leaderboard's query filter. Three names were left out on purpose because nothing reads them at runtime: `OAUTH_TIMEOUT` and `OAUTH_TOKEN_ENDPOINT_AUTH_METHOD` are stored but never consumed, and `TRUSTED_SIGNATURE_KEY` feeds a helper no code calls. ## Related issue or discussion None. Follow-up to #1395. ## Checklist - [x] I have reviewed the relevant documentation and matched the existing style. - [x] This PR meets Open WebUI's contribution standards: it is accurate, relevant to users, narrowly scoped, maintainable, and not promotional content, advertising, lead generation, SEO placement, or a request to list a product, service, provider, integration, gateway, tool, or company primarily for visibility. - [x] I understand that PRs that do not meet these standards may be closed without review and will not be merged. Repeated, low-quality, off-topic, promotional, or intentionally misleading submissions may result in the contributor being blocked from future participation in Open WebUI repositories. ## Notes for reviewers Defaults and behavior come from `config.py`, `env.py`, `utils/oauth.py`, `routers/auths.py`, `routers/evaluations.py`, `events.py`, `main.py`, and the Datalab and MinerU loaders on `dev`. The Datalab field meanings come from Datalab's `/convert` API reference where it lists them. Additions only, no existing entry changed, so every existing anchor still resolves. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>

bsakaguchi

2026-10-18 14:19:07 +00:00