[PR #1421] [CLOSED] docs: correct the development and logging pages against the Vite proxy, the build config and the JSON log formatters #1386

New issue

Closed

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

bsakaguchi commented

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

Owner

📋 Pull Request Information

Original PR: https://github.com/open-webui/docs/pull/1421
Author: @silentoplayz
Created: 9/18/2026
Status: ❌ Closed

Base: main ← Head: docs/development-logging-pages

📝 Commits (1)

8e102f0 docs: correct the development and logging pages against the Vite proxy, the build config and the JSON log formatters

📊 Changes

2 files changed (+13 additions, -9 deletions)

View changed files

📝 docs/getting-started/advanced-topics/development.md (+8 -6)
📝 docs/getting-started/advanced-topics/logging.md (+5 -3)

📄 Description

Summary

I compared the development and logging pages with the frontend build config, the dev scripts and the log formatters.

Development: package.json allows Node.js up to 22.x, and the locked dependencies (pdfjs-dist among them) need 20.19 or later, so the requirement is 20.19+ on Node 20 or 22.13+ on Node 22 rather than 22.10 and up. The LAN-testing steps keep the CORS_ALLOW_ORIGIN step: the Vite dev server proxies /api, /ollama, /openai, /oauth and /ws, but Socket.IO still checks the browser's Origin against that list (WEBUI_BACKEND_URL points the proxy elsewhere). Ports are changed with PORT and npm run dev:5050 (plus that port's origin in CORS_ALLOW_ORIGIN), not by editing config files. With no backend, the page redirects to a "Backend Required" error page rather than waiting, and /docs is served only with ENV=dev.
Logging: production builds strip console.log, console.debug and console.error unless built with ENV=dev, so the frontend section now says so. The JSON error field is an object with type, message and stacktrace, and the top-level stacktrace only appears on the few lines written before the Loguru sink starts. An unrecognised GLOBAL_LOG_LEVEL falls back to INFO, and SRC_LOG_LEVELS is a legacy placeholder.

None.

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

Sources on dev: package.json (engines, scripts), vite.config.ts (proxy, esbuild.pure), backend/dev.sh, main.py (docs_url), src/routes/+layout.svelte and src/routes/error/+page.svelte, utils/logger.py, and env.py (JSONFormatter, GLOBAL_LOG_LEVEL, SRC_LOG_LEVELS).

_{🔄 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/1421 **Author:** [@silentoplayz](https://github.com/silentoplayz) **Created:** 9/18/2026 **Status:** ❌ Closed **Base:** `main` ← **Head:** `docs/development-logging-pages` --- ### 📝 Commits (1) - [`8e102f0`](https://github.com/open-webui/docs/commit/8e102f0826badf2d00da572cc092dcc72bd15d91) docs: correct the development and logging pages against the Vite proxy, the build config and the JSON log formatters ### 📊 Changes **2 files changed** (+13 additions, -9 deletions) <details> <summary>View changed files</summary> 📝 `docs/getting-started/advanced-topics/development.md` (+8 -6) 📝 `docs/getting-started/advanced-topics/logging.md` (+5 -3) </details> ### 📄 Description ## Summary I compared the development and logging pages with the frontend build config, the dev scripts and the log formatters. - Development: `package.json` allows Node.js up to 22.x, and the locked dependencies (`pdfjs-dist` among them) need 20.19 or later, so the requirement is 20.19+ on Node 20 or 22.13+ on Node 22 rather than 22.10 and up. The LAN-testing steps keep the `CORS_ALLOW_ORIGIN` step: the Vite dev server proxies `/api`, `/ollama`, `/openai`, `/oauth` and `/ws`, but Socket.IO still checks the browser's `Origin` against that list (`WEBUI_BACKEND_URL` points the proxy elsewhere). Ports are changed with `PORT` and `npm run dev:5050` (plus that port's origin in `CORS_ALLOW_ORIGIN`), not by editing config files. With no backend, the page redirects to a "Backend Required" error page rather than waiting, and `/docs` is served only with `ENV=dev`. - Logging: production builds strip `console.log`, `console.debug` and `console.error` unless built with `ENV=dev`, so the frontend section now says so. The JSON `error` field is an object with `type`, `message` and `stacktrace`, and the top-level `stacktrace` only appears on the few lines written before the Loguru sink starts. An unrecognised `GLOBAL_LOG_LEVEL` falls back to `INFO`, and `SRC_LOG_LEVELS` is a legacy placeholder. ## Related issue or discussion None. ## 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 Sources on `dev`: `package.json` (engines, scripts), `vite.config.ts` (proxy, `esbuild.pure`), `backend/dev.sh`, `main.py` (`docs_url`), `src/routes/+layout.svelte` and `src/routes/error/+page.svelte`, `utils/logger.py`, and `env.py` (`JSONFormatter`, `GLOBAL_LOG_LEVEL`, `SRC_LOG_LEVELS`). --- <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:18 +00:00