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 for validating 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 cleary 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
AZURE_STORAGE_ENDPOINT: To configure the Azure Storage service endpoint to connect to.
AZURE_STORAGE_KEY: To configure the Azure Storage key to authenticate with the service
Optional - if not provided, credentials will be taken from the environment. User credentials if run locally and Managed Identity if run in Azure services.
AZURE_STORAGE_CONTAINER_NAME: To configure the Azure Blob Storage Container where files will be stored.
Added unit tests for the AzureStorageProvider
Changed
N/A
Deprecated
N/A
Removed
N/A
Fixed
N/A
Security
N/A
Breaking Changes
None
Additional Information
N/A
Screenshots or Videos
files being stored in Azure Storage
chat ui with file uploaded and displaying contents
Changelog
Added
🗂️ Azure Storage Provider Support: Scaled deployments now benefit from expanded storage options with Azure Storage seamlessly integrated as a provider.
🔄 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/10308
**Author:** [@crpietschmann](https://github.com/crpietschmann)
**Created:** 2/18/2025
**Status:** ✅ Merged
**Merged:** 2/19/2025
**Merged by:** [@tjbck](https://github.com/tjbck)
**Base:** `dev` ← **Head:** `azure-storage`
---
### 📝 Commits (10+)
- [`e4c9734`](https://github.com/open-webui/open-webui/commit/e4c9734fcba5105c30de874fd4c21c602dbd08a6) Merge pull request #10038 from open-webui/dev
- [`c513308`](https://github.com/open-webui/open-webui/commit/c513308dedcf3691c06713705c082c37592b5c51) Merge pull request #10236 from open-webui/dev
- [`3f3a5bb`](https://github.com/open-webui/open-webui/commit/3f3a5bb0ab8ce3425f317f1e57b084523aa2b2a5) Merge pull request #10238 from open-webui/dev
- [`fd3c24a`](https://github.com/open-webui/open-webui/commit/fd3c24af4e1ea80a45a4b26271cb8d08fb12a42a) Add AzureStorageProvider
- [`e4febfa`](https://github.com/open-webui/open-webui/commit/e4febfa0974c6433b97f5e483430a33bb88e9941) Add AzureStorageProvider config options
- [`aee5710`](https://github.com/open-webui/open-webui/commit/aee57107bcafac2e7a363c9a9b7b046398c00c55) Update config.py
- [`745b24f`](https://github.com/open-webui/open-webui/commit/745b24f13a1b537519f70bf3b734a4f2d7eb6dc4) Merge branch 'open-webui:main' into azure-storage
- [`cc4598c`](https://github.com/open-webui/open-webui/commit/cc4598c41baea60dbaee2b26eab77d0e489bc876) Update build-release.yml
- [`13227fc`](https://github.com/open-webui/open-webui/commit/13227fc0175aebc74646f7ede54e0d7a030c6eaa) Merge branch 'azure-storage' of https://github.com/crpietschmann/open-webui into azure-storage
- [`2f4f4c2`](https://github.com/open-webui/open-webui/commit/2f4f4c23764b03230cd626e3ba47b4ba93067450) add tests
### 📊 Changes
**4 files changed** (+234 additions, -0 deletions)
<details>
<summary>View changed files</summary>
📝 `backend/open_webui/config.py` (+4 -0)
📝 `backend/open_webui/storage/provider.py` (+76 -0)
📝 `backend/open_webui/test/apps/webui/storage/test_provider.py` (+150 -0)
📝 `backend/requirements.txt` (+4 -0)
</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.
- [x] **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 for validating 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 cleary 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
- Adds support for Microsoft Azure Blob Storage
Here's the documentation PR that goes along with this: https://github.com/open-webui/docs/pull/410
### Added
- Added the `azure` option for `STORAGE_PROVIDER`
- Add the AzureStorageProvider class
- Added the following related config values:
- `AZURE_STORAGE_ENDPOINT`: To configure the Azure Storage service endpoint to connect to.
- `AZURE_STORAGE_KEY`: To configure the Azure Storage key to authenticate with the service
- Optional - if not provided, credentials will be taken from the environment. User credentials if run locally and Managed Identity if run in Azure services.
- `AZURE_STORAGE_CONTAINER_NAME`: To configure the Azure Blob Storage Container where files will be stored.
- Added unit tests for the AzureStorageProvider
### Changed
- N/A
### Deprecated
- N/A
### Removed
- N/A
### Fixed
- N/A
### Security
- N/A
### Breaking Changes
- None
---
### Additional Information
- N/A
### Screenshots or Videos
- files being stored in Azure Storage
- chat ui with file uploaded and displaying contents
# Changelog
### Added
- **🗂️ Azure Storage Provider Support**: Scaled deployments now benefit from expanded storage options with Azure Storage seamlessly integrated as a provider.
---
<sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
Blocking a user prevents them from interacting with repositories, such as opening or commenting on pull requests or issues. Learn more about blocking a user.
📋 Pull Request Information
Original PR: https://github.com/open-webui/open-webui/pull/10308
Author: @crpietschmann
Created: 2/18/2025
Status: ✅ Merged
Merged: 2/19/2025
Merged by: @tjbck
Base:
dev← Head:azure-storage📝 Commits (10+)
e4c9734Merge pull request #10038 from open-webui/devc513308Merge pull request #10236 from open-webui/dev3f3a5bbMerge pull request #10238 from open-webui/devfd3c24aAdd AzureStorageProvidere4febfaAdd AzureStorageProvider config optionsaee5710Update config.py745b24fMerge branch 'open-webui:main' into azure-storagecc4598cUpdate build-release.yml13227fcMerge branch 'azure-storage' of https://github.com/crpietschmann/open-webui into azure-storage2f4f4c2add tests📊 Changes
4 files changed (+234 additions, -0 deletions)
View changed files
📝
backend/open_webui/config.py(+4 -0)📝
backend/open_webui/storage/provider.py(+76 -0)📝
backend/open_webui/test/apps/webui/storage/test_provider.py(+150 -0)📝
backend/requirements.txt(+4 -0)📄 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:
devbranch.Changelog Entry
Description
Here's the documentation PR that goes along with this: https://github.com/open-webui/docs/pull/410
Added
azureoption forSTORAGE_PROVIDERAZURE_STORAGE_ENDPOINT: To configure the Azure Storage service endpoint to connect to.AZURE_STORAGE_KEY: To configure the Azure Storage key to authenticate with the serviceAZURE_STORAGE_CONTAINER_NAME: To configure the Azure Blob Storage Container where files will be stored.Changed
Deprecated
Removed
Fixed
Security
Breaking Changes
Additional Information
Screenshots or Videos
Changelog
Added
🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.