[PR #15583] [CLOSED] feat: prepare for subpath #10674

New Issue

GiteaMirror · 2025-11-11T19:10:56-06:00

GiteaMirror commented

2025-11-11 19:10:56 -06:00

📋 Pull Request Information

Original PR: https://github.com/open-webui/open-webui/pull/15583
Author: @guenhter
Created: 7/8/2025
Status: ❌ Closed

Base: dev ← Head: prepare-for-subpath

📝 Commits (2)

0993f2a feat: consider base path for picture urls in python
7bc923b feat: support base-path var in web part

📊 Changes

94 files changed (+363 additions, -368 deletions)

View changed files

📝 backend/open_webui/config.py (+2 -7)
📝 backend/open_webui/main.py (+8 -28)
📝 backend/open_webui/models/models.py (+0 -1)
📝 backend/open_webui/models/users.py (+0 -1)
📝 backend/open_webui/utils/oauth.py (+6 -5)
📝 src/lib/apis/index.ts (+1 -1)
📝 src/lib/components/NotificationToast.svelte (+3 -2)
📝 src/lib/components/OnBoarding.svelte (+2 -2)
📝 src/lib/components/admin/Evaluations.svelte (+3 -2)
📝 src/lib/components/admin/Evaluations/Feedbacks.svelte (+2 -1)
📝 src/lib/components/admin/Evaluations/Leaderboard.svelte (+2 -1)
📝 src/lib/components/admin/Functions.svelte (+6 -5)
📝 src/lib/components/admin/Functions/FunctionEditor.svelte (+2 -1)
📝 src/lib/components/admin/Settings.svelte (+14 -13)
📝 src/lib/components/admin/Settings/Evaluations/ArenaModelModal.svelte (+3 -2)
📝 src/lib/components/admin/Settings/Models.svelte (+2 -1)
📝 src/lib/components/admin/Users.svelte (+4 -3)
📝 src/lib/components/admin/Users/Groups.svelte (+2 -1)
📝 src/lib/components/admin/Users/Groups/Users.svelte (+1 -1)
📝 src/lib/components/admin/Users/UserList.svelte (+1 -1)

...and 74 more files

📄 Description

Pull Request Checklist

Note to first-time contributors: Please open a discussion post in Discussions and describe your changes before submitting a pull request.

Before submitting, make sure you've checked the following:

Target branch: Please verify that the pull request targets the dev branch.
Description: Provide a concise description of the changes made in this pull request.
Changelog: Ensure a changelog entry following the format of Keep a Changelog is added at the bottom of the PR description.
Documentation: Have you updated relevant documentation Open WebUI Docs, or other documentation sources?
Dependencies: Are there any new dependencies? Have you updated the dependency versions in the documentation?
Testing: Have you written and run sufficient tests to validate the changes?
Code review: Have you performed a self-review of your code, addressing any coding standard issues and ensuring adherence to the project's coding standards?
Prefix: To clearly categorize this pull request, prefix the pull request title using one of the following:
- BREAKING CHANGE: Significant changes that may affect compatibility
- build: Changes that affect the build system or external dependencies
- ci: Changes to our continuous integration processes or workflows
- chore: Refactor, cleanup, or other non-functional code changes
- docs: Documentation update or addition
- feat: Introduces a new feature or enhancement to the codebase
- fix: Bug fix or error correction
- i18n: Internationalization or localization changes
- perf: Performance improvement
- refactor: Code restructuring for better maintainability, readability, or scalability
- style: Changes that do not affect the meaning of the code (white space, formatting, missing semi-colons, etc.)
- test: Adding missing tests or correcting existing tests
- WIP: Work in progress, a temporary label for incomplete or ongoing work

Changelog Entry

Description

The request of hosting Open WebUI under a subpath (e.g. http://localhost/foobar/) is not new. Some attempts were already done in the past, but non of them made it: https://github.com/open-webui/open-webui/pull/10440, https://github.com/open-webui/open-webui/pull/2148, https://github.com/open-webui/open-webui/pull/1701

All of them tried the same approach: Changing the OWUI to relative paths.

Using relative paths is a critical thing, because we'd have to consider a lot of edge cases. Having absolute paths is here way more robust and easy to develop.

This PR prepares now everything that subpathing can be done quite easy with only a few minor steps. So it is then very easy to host OWUI not longer directly under "/" but e.g. under "/some/".

It is important, that paths always stays absolute paths.

If no base-path is defined, nothing changes. All the paths stay exactly as they are!

Subpathing will be done with those (manual) steps:

Change two files in the Docker Container (index.html and some generated .js file)
Create a reverse proxy which strips the paths for the backend

When this PR gets merged, I'll create a new PR in the docs repo to give some guideline what needs to be done to make the subpath work.

Changed

Adapt a lot of URLs to support base-paths prepending

Screenshots or Videos

Contributor License Agreement

By submitting this pull request, I confirm that I have read and fully agree to the Contributor License Agreement (CLA), and I am providing my contributions under its terms.

_{🔄 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/open-webui/pull/15583 **Author:** [@guenhter](https://github.com/guenhter) **Created:** 7/8/2025 **Status:** ❌ Closed **Base:** `dev` ← **Head:** `prepare-for-subpath` --- ### 📝 Commits (2) - [`0993f2a`](https://github.com/open-webui/open-webui/commit/0993f2ac4a686babf2c2d3b80be6dc37458f7826) feat: consider base path for picture urls in python - [`7bc923b`](https://github.com/open-webui/open-webui/commit/7bc923bc14ff21bae2e9cb75664813e3af47d2e3) feat: support base-path var in web part ### 📊 Changes **94 files changed** (+363 additions, -368 deletions) <details> <summary>View changed files</summary> 📝 `backend/open_webui/config.py` (+2 -7) 📝 `backend/open_webui/main.py` (+8 -28) 📝 `backend/open_webui/models/models.py` (+0 -1) 📝 `backend/open_webui/models/users.py` (+0 -1) 📝 `backend/open_webui/utils/oauth.py` (+6 -5) 📝 `src/lib/apis/index.ts` (+1 -1) 📝 `src/lib/components/NotificationToast.svelte` (+3 -2) 📝 `src/lib/components/OnBoarding.svelte` (+2 -2) 📝 `src/lib/components/admin/Evaluations.svelte` (+3 -2) 📝 `src/lib/components/admin/Evaluations/Feedbacks.svelte` (+2 -1) 📝 `src/lib/components/admin/Evaluations/Leaderboard.svelte` (+2 -1) 📝 `src/lib/components/admin/Functions.svelte` (+6 -5) 📝 `src/lib/components/admin/Functions/FunctionEditor.svelte` (+2 -1) 📝 `src/lib/components/admin/Settings.svelte` (+14 -13) 📝 `src/lib/components/admin/Settings/Evaluations/ArenaModelModal.svelte` (+3 -2) 📝 `src/lib/components/admin/Settings/Models.svelte` (+2 -1) 📝 `src/lib/components/admin/Users.svelte` (+4 -3) 📝 `src/lib/components/admin/Users/Groups.svelte` (+2 -1) 📝 `src/lib/components/admin/Users/Groups/Users.svelte` (+1 -1) 📝 `src/lib/components/admin/Users/UserList.svelte` (+1 -1) _...and 74 more files_ </details> ### 📄 Description # Pull Request Checklist ### Note to first-time contributors: Please open a discussion post in [Discussions](https://github.com/open-webui/open-webui/discussions) and describe your changes before submitting a pull request. **Before submitting, make sure you've checked the following:** - [x] **Target branch:** Please verify that the pull request targets the `dev` branch. - [x] **Description:** Provide a concise description of the changes made in this pull request. - [x] **Changelog:** Ensure a changelog entry following the format of [Keep a Changelog](https://keepachangelog.com/) is added at the bottom of the PR description. - [ ] **Documentation:** Have you updated relevant documentation [Open WebUI Docs](https://github.com/open-webui/docs), or other documentation sources? - [x] **Dependencies:** Are there any new dependencies? Have you updated the dependency versions in the documentation? - [x] **Testing:** Have you written and run sufficient tests to validate the changes? - [x] **Code review:** Have you performed a self-review of your code, addressing any coding standard issues and ensuring adherence to the project's coding standards? - [x] **Prefix:** To clearly categorize this pull request, prefix the pull request title using one of the following: - **BREAKING CHANGE**: Significant changes that may affect compatibility - **build**: Changes that affect the build system or external dependencies - **ci**: Changes to our continuous integration processes or workflows - **chore**: Refactor, cleanup, or other non-functional code changes - **docs**: Documentation update or addition - **feat**: Introduces a new feature or enhancement to the codebase - **fix**: Bug fix or error correction - **i18n**: Internationalization or localization changes - **perf**: Performance improvement - **refactor**: Code restructuring for better maintainability, readability, or scalability - **style**: Changes that do not affect the meaning of the code (white space, formatting, missing semi-colons, etc.) - **test**: Adding missing tests or correcting existing tests - **WIP**: Work in progress, a temporary label for incomplete or ongoing work # Changelog Entry ### Description The request of hosting Open WebUI under a subpath (e.g. http://localhost/foobar/) is not new. Some attempts were already done in the past, but non of them made it: https://github.com/open-webui/open-webui/pull/10440, https://github.com/open-webui/open-webui/pull/2148, https://github.com/open-webui/open-webui/pull/1701 All of them tried the same approach: Changing the OWUI to relative paths. Using relative paths is a critical thing, because we'd have to consider a lot of edge cases. Having absolute paths is here way more robust and easy to develop. This PR prepares now everything that subpathing can be done quite easy with only a few minor steps. So it is then very easy to host OWUI not longer directly under `"/"` but e.g. under `"/some/"`. It is important, that paths always stays absolute paths. **If no base-path is defined, nothing changes. All the paths stay exactly as they are!** Subpathing will be done with those (manual) steps: * Change two files in the Docker Container (`index.html` and some generated `.js` file) * Create a reverse proxy which strips the paths for the backend When this PR gets merged, I'll create a new PR in the docs repo to give some guideline what needs to be done to make the subpath work. ### Changed - Adapt a lot of URLs to support base-paths prepending --- ### Screenshots or Videos ![subpath](https://github.com/user-attachments/assets/0ece33e8-26bb-411b-a450-19974fd00c0e) ### Contributor License Agreement By submitting this pull request, I confirm that I have read and fully agree to the [Contributor License Agreement (CLA)](/CONTRIBUTOR_LICENSE_AGREEMENT), and I am providing my contributions under its terms. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>

GiteaMirror added the pull-request label 2025-11-11 19:10:56 -06:00

GiteaMirror closed this issue

2025-11-11 19:10:57 -06:00

GiteaMirror referenced this issue

2026-04-19 22:02:46 -05:00

[GH-ISSUE #10674] open open-webui direct link and extra message, No login is required. #15987

GiteaMirror referenced this issue

2026-04-25 05:25:57 -05:00

[GH-ISSUE #10674] open open-webui direct link and extra message, No login is required. #31516

GiteaMirror referenced this issue

2026-05-05 16:31:02 -05:00

[GH-ISSUE #10674] open open-webui direct link and extra message, No login is required. #54653