Skip to content

docs: correct the development and logging pages against the Vite proxy, the build config and the JSON log formatters - #1421

Open
silentoplayz wants to merge 1 commit into
open-webui:mainfrom
silentoplayz:docs/development-logging-pages
Open

silentoplayz wants to merge 1 commit into
open-webui:mainfrom
silentoplayz:docs/development-logging-pages

Conversation

@silentoplayz

Copy link
Copy Markdown
Collaborator

Summary

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

  • Development: package.json declares Node.js versions 18.13 through 22.x, not 22.10 and up. The LAN-testing steps told readers to add their origin to CORS_ALLOW_ORIGIN. The Vite dev server proxies /api, /ollama, /openai, /oauth and /ws, so the browser never crosses origins and no CORS change is needed (WEBUI_BACKEND_URL points the proxy elsewhere). Ports are changed with PORT and npm run dev:5050, 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

  • 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).

…y, the build config and the JSON log formatters
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.

1 participant