Update env-configuration with maintenance warnings

Added warnings and information about community-maintained vector stores and multitenancy risks.
This commit is contained in:
Classic298
2025-11-10 16:28:46 +01:00
committed by GitHub
parent 177685d394
commit dab2190019

View File

@@ -1187,6 +1187,13 @@ pip install open-webui[all]
:::
:::info
Only PGVector and ChromaDB will be consistently maintained by the Open WebUI team.
The other vector stores are community-added vector databases.
:::
### ChromaDB
#### `CHROMA_TENANT`
@@ -1289,6 +1296,13 @@ pip install open-webui[all]
### Milvus
:::warning
Milvus is not actively maintained by the Open WebUI team. It is an addition by the community and is maintained by the community.
If you want to use Milvus, be careful when upgrading Open WebUI (crate backups and snapshots for rollbacks) in case internal changes in Open WebUI lead to breakage.
:::
#### `MILVUS_URI`
- Type: `str`
@@ -1425,9 +1439,7 @@ After successful migration (from milvus to multitenancy milvus), legacy collecti
- Collection naming dependency: Multitenancy relies on Open WebUI's internal collection naming conventions (user-memory-, file-, web-search-, hash patterns). **If Open WebUI changes these conventions in future updates, multitenancy routing may break, causing data corruption or incorrect data retrieval across isolated resources.**
- No automatic rollback: Disabling multitenancy after data is written will not restore access to the shared collections. Data would need manual extraction and re-import.
**For fresh installations:**
- Multitenancy is recommended and enabled by default (true)
- No migration concerns exist
For fresh installations, no migration concerns exist
**For existing installations with valuable data:**
- Do not migrate to multitenancy mode if you do not want to handle migration and risk data loss
@@ -1445,6 +1457,17 @@ After successful migration (from milvus to multitenancy milvus), legacy collecti
:::
:::warning
The mapping of multitenancy relies on current Open WebUI naming conventions for collection names.
If Open WebUI changes how it generates collection names (e.g., "user-memory-" prefix, "file-" prefix, web search patterns, or hash formats), this mapping will break and route data to incorrect collections.
POTENTIALLY CAUSING HUGE DATA CORRUPTION, DATA CONSISTENCY ISSUES AND INCORRECT DATA MAPPING INSIDE THE DATABASE.
If you use Multitenancy Mode, you should always check for any changes to the collection names and data mapping before upgrading, and upgrade carefully (snapshots and backups for rollbacks)!
:::
#### `MILVUS_COLLECTION_PREFIX`
- Type: `str`
@@ -1522,6 +1545,13 @@ If set to `false`, open-webui will assume the postgreSQL database where embeddin
### Qdrant
:::warning
Qdrant is not actively maintained by the Open WebUI team. It is an addition by the community and is maintained by the community.
If you want to use Qdrant, be careful when upgrading Open WebUI (crate backups and snapshots for rollbacks) in case internal changes in Open WebUI lead to breakage.
:::
#### `QDRANT_API_KEY`
- Type: `str`
@@ -1594,6 +1624,17 @@ If you decide to use the multitenancy pattern as your default and you don't need
:::
:::warning
The mapping of multitenancy relies on current Open WebUI naming conventions for collection names.
If Open WebUI changes how it generates collection names (e.g., "user-memory-" prefix, "file-" prefix, web search patterns, or hash formats), this mapping will break and route data to incorrect collections.
POTENTIALLY CAUSING HUGE DATA CORRUPTION, DATA CONSISTENCY ISSUES AND INCORRECT DATA MAPPING INSIDE THE DATABASE.
If you use Multitenancy Mode, you should always check for any changes to the collection names and data mapping before upgrading, and upgrade carefully (snapshots and backups for rollbacks)!
:::
#### `QDRANT_COLLECTION_PREFIX`
- Type: `str`