khanh.pndc/open-webui-docs
1
0
Fork 0
mirror of https://github.com/open-webui/docs.git synced 2026-01-04 10:46:26 +07:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'main' into dev

Browse Source
This commit is contained in:
Classic298
2025-09-29 10:21:05 +02:00
committed by GitHub
parent 6799e71367 40238aad83
commit a859130848
5 changed files with 29 additions and 24 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
docs/enterprise/index.mdx
View File

@@ -25,9 +25,12 @@ In the rapidly advancing AI landscape, staying ahead isn't just a competitive ad
## **Let’s Talk**
:::info
To help us respond quickly and efficiently to your inquiry, **please use your official work email address**—Gmail and Hotmail accounts are often blocked by our system and cannot be found.
:::
Enterprise licenses and partnership opportunities are available exclusively to registered entities and organizations. At this time, we are unable to accommodate individual users. We appreciate your understanding and interest.
To help us respond quickly and efficiently to your inquiry, **please use your official work email address**—Personal email accounts (e.g. gmail.com, hotmail.com, icloud.com, etc.) are often blocked by our system and cannot be found.
:::
📧 **sales@openwebui.com** — Send us your deployment **end user count (seats)**, and let’s explore how we can work together! Support available in **English & Korean (한국어), with more languages coming soon!**
@@ -71,6 +74,8 @@ Thank you for understanding and respecting our partnership process.
:::
---
<Testimonals />

5
docs/features/sso/index.mdx
View File

@@ -39,13 +39,14 @@ You cannot have Microsoft **and** Google as providers simultaneously.
| Environment Variable | Default | Description |
|---------------------------------------|-----------|-----------------------------------------------------------------------------------------------------------------------------------------|
| `WEBUI_URL` | — | **Required.** Your public WebUI address, e.g., `http://localhost:8080`. |
| `WEBUI_URL` | — | **Required.** Your public WebUI address, e.g., `http://localhost:8080`. |
| `ENABLE_OAUTH_PERSISTENT_CONFIG` | `true` | Persist OAuth config to the database; set to `false` for stateless/containerized environments. |
| `ENABLE_OAUTH_SIGNUP` | `false` | Allows account creation upon OAuth login (separate from `ENABLE_SIGNUP`). |
| `OAUTH_MERGE_ACCOUNTS_BY_EMAIL` | `false` | Merge OAuth logins based on matching email (⚠️ caution: can be insecure if provider doesn't verify emails). |
| `OAUTH_MERGE_ACCOUNTS_BY_EMAIL` | `false` | Merge OAuth logins based on matching email (caution: can be insecure if provider doesn't verify emails). |
| `OAUTH_UPDATE_PICTURE_ON_LOGIN` | `true` | Update user profile pictures from OAuth provider with each login. |
| `OAUTH_PICTURE_CLAIM` | `picture` | Field in the claim containing the profile picture. Set to empty string to disable picture updates (users receive default icon).|
| `WEBUI_AUTH_SIGNOUT_REDIRECT_URL` | *empty* | Redirect users to this URL after signout. E.g., `https://your-company.com/logout-success` |
| `WEBUI_SECRET_KEY` | *empty* | MUST be set - especially in clustered environments. Otherwise session issues and weird OAuth issues will occur |
| `OAUTH_SESSION_TOKEN_ENCRYPTION_KEY` | `WEBUI_SECRET_KEY` | A secret key for encrypting OAuth tokens stored on the server. Must be shared across all instances in a cluster. |
| `OAUTH_CLIENT_INFO_ENCRYPTION_KEY` | `WEBUI_SECRET_KEY` | A secret key for encrypting OAuth client information stored on the server - used for OAuth 2.1 authentication for MCP servers. |
| `ENABLE_OAUTH_ID_TOKEN_COOKIE` | `true` | For backward compatibility. Controls if the legacy `oauth_id_token` cookie is set. Recommended to set to `false`. |

4
docs/getting-started/env-configuration.md
View File

@@ -1013,7 +1013,9 @@ directly. Ensure that no users are present in the database if you intend to turn
:::info
When deploying Open WebUI in a multi-node/worker cluster with a load balancer, you must ensure that the WEBUI_SECRET_KEY value is the same across all instances in order to enable users to continue working if a node is recycled or their session is transferred to a different node. Without it, they will need to sign in again each time the underlying node changes.
This variable is always needed when using OAUTH, especially in clustered environments, but even in single-process environments.
Otherwise, OAUTH issues may occur.
:::

7
docs/intro.mdx
View File

@@ -128,6 +128,13 @@ docker run -d --name watchtower --restart unless-stopped -v /var/run/docker.sock
## Manual Installation
:::info
### Platform Compatibility
Open WebUI works on macOS, Linux (x86_64 and ARM64, including Raspberry Pi and other ARM boards), and Windows.
:::
There are two main ways to install and run Open WebUI: using the `uv` runtime manager or Python's `pip`. While both methods are effective, **we strongly recommend using `uv`** as it simplifies environment management and minimizes potential conflicts.
### Installation with `uv` (Recommended)

28
docs/license.mdx
View File

@@ -14,7 +14,7 @@ If you've been following Open WebUI’s journey, you know our mission has always
But with Open WebUI’s rapid growth and success, we started seeing a pattern we couldn’t ignore: **bad actors taking our work, stripping the branding, selling it as their own, and giving nothing back.** That’s not open source—that’s exploitation. When organizations profit off our efforts, misrepresent our work, and box out the real community, it threatens the very spirit of what we’re trying to build.
That’s why we’ve acted: **with Open WebUI v0.6.6+ (April 2025), our license remains permissive, BSD-3-based, but now adds a fair-use branding protection clause**. This update does **not** impact genuine users, contributors, or anyone who simply wants to use the software in good faith. If you’re a real contributor, a small team, or an organization adopting Open WebUI for internal use—**nothing changes for you**. This change **only affects those who intend to exploit the project’s goodwill**: stripping away its identity, falsely representing it, and never giving back.
That’s why we’ve acted: **with Open WebUI v0.6.6+ (April 2025), our license remains permissive, but now adds a fair-use branding protection clause**. This update does **not** impact genuine users, contributors, or anyone who simply wants to use the software in good faith. If you’re a real contributor, a small team, or an organization adopting Open WebUI for internal use—**nothing changes for you**. This change **only affects those who intend to exploit the project’s goodwill**: stripping away its identity, falsely representing it, and never giving back.
In plain terms:
- **Open WebUI is still free and permissively licensed.**
@@ -29,21 +29,20 @@ We take your trust seriously. We want Open WebUI to stay **empowering and access
## Open WebUI License: Explained
**Effective with v0.6.6 (April 19, 2025):**
Open WebUI’s license is now:
Open WebUI’s license now:
- **BSD-3-Clause based**, with an additional branding restriction clause:
- Includes an additional branding restriction clause:
- **You may NOT alter, remove, or obscure any “Open WebUI” branding** (name, logo, UI marks, etc.) in any deployment or distribution, except in the circumstances below.
- Branding must remain clearly visible, unless:
1. **You have 50 or fewer users** in a 30-day period;
2. **You are a contributor**, and have gotten written permission from us for an internal deployment;
3. **You’ve secured an enterprise license** from us which explicitly allows branding changes.
- **CLA required for new contributions** after v0.6.5 (v0.6.6+) under the updated license.
- **All code submitted/merged to the codebase up to and including release v0.6.5 remains BSD-3 licensed** (no branding requirement applies for that legacy code).
- **CLA required for new contributions** after v0.6.5 (v0.6.6+) under the updated license.
:::tip
**TL;DR: Want to use Open WebUI for free? Just keep the branding.**
@@ -57,7 +56,7 @@ This is not legal advice—refer to the full [LICENSE](https://github.com/open-w
### **1. Can I still use Open WebUI freely for personal projects, businesses, or teaching?**
**Yes!** Just don’t remove or alter the “Open WebUI” branding, and you’re covered by the very permissive BSD-3-Clause plus our light branding protection. Just don’t pretend your distribution is “official” from us if it isn’t.
**Yes!** Just don’t remove or alter the “Open WebUI” branding, and you’re covered by the very permissive license with our light branding protection. Just don’t pretend your distribution is “official” from us if it isn’t.
### **2. I want to fork Open WebUI and change the UI to fit my use case. Is that allowed?**
@@ -143,15 +142,11 @@ If in doubt, or if you have concerns about your past or future contributions, pl
It's a great—and complicated—question, because **"open source" can mean many different things to many people**.
If we're being precise:
- According to the strict definition laid out by organizations like the [Open Source Initiative (OSI)](https://opensource.org/osd), *any* license restriction that dictates branding or limits how you present derivatives **technically** means the software is no longer "OSI open source."
- There are similar, nuanced discussions in the wider community: for instance, the Debian Free Software Guidelines, Fedora’s stance, and others, **all differ somewhat in interpretation**.
So:
- **In the narrowest, most “by-the-book” sense—our new branding clause means Open WebUI v0.6.6+ isn’t OSI-certified "open source.”**
- Example: The OSI would not certify licenses that require you to keep original branding.
- However, compared to what most people mean in practice — **“is the code available, can I use it, fork it, change it, build things with it, and not pay you or get a special key?”** — the answer is still a resounding **yes**.
- We are far more open than most so-called “open core” commercial/AGPL/SSPL models, which often wall off features, require payments for APIs, or keep critical work private.
- We are far more open than most so-called “open core” projects, which often wall off features, require payments for APIs, or keep critical work private.
**What does all this mean in practice for you?**
- *All of the source code is public and developed in the open.*
@@ -167,11 +162,6 @@ Some projects in our position have responded to exploitation by:
**We didn’t want to do that.**
We want a single, shared, public codebase where everyone—from solo hackers to enterprises—can benefit from the same core improvements, transparent development, and community fixes.
**To sum up:**
- *Strictly speaking*, our license after v0.6.6 isn’t “open source” according to OSI’s official rules.
- *Practically speaking*, it remains radically more open, transparent, and community-driven than most commercial “source-available” projects.
- **Our goal is to maximize freedom, fairness, and sustainability—for everyone.**
We believe open ecosystems work best for users, contributors, and the future of AI. If you ever need more permissions or have questions, just talk to us—we’re committed to finding solutions that respect our contributors and community.
### **7. What if I want to white-label or deeply customize Open WebUI for my enterprise?**
@@ -227,7 +217,7 @@ We’re happy to help make Open WebUI accessible for your research—just ask!
If you operate a public fork, or a paid SaaS, and retain the Open WebUI branding:
> _“This project is a customized fork of [Open WebUI](https://github.com/open-webui/open-webui), the community-driven open-source AI platform. This release is not affiliated with or maintained by the official Open WebUI team.”_
> _“This project is a customized fork of [Open WebUI](https://github.com/open-webui/open-webui). This release is not affiliated with or maintained by the official Open WebUI team.”_
Display this message—prominently—in the About section, landing page, or equivalent location. **Transparency is required.**