github-starred/open-webui
2
0
Fork 0
mirror of https://github.com/open-webui/open-webui.git synced 2026-05-05 18:38:17 -05:00
Code Issues 1.1k Packages Projects Releases 126 Wiki Activity

[PR #9596] [MERGED] feat: add s3 key prefix support #22391

New Issue
Closed
opened 2026-04-20 04:06:58 -05:00 by GiteaMirror · 0 comments
GiteaMirror commented 2026-04-20 04:06:58 -05:00
Owner
Copy Link

📋 Pull Request Information

Original PR: https://github.com/open-webui/open-webui/pull/9596
Author: @engineeringpatrick
Created: 2/7/2025
Status: ✅ Merged
Merged: 2/9/2025
Merged by: @tjbck

Base: dev ← Head: main

📝 Commits (3)

  • 5ca6afc add s3 key prefix support
  • 7f82476 use key_prefix in rest of S3StorageProvider
  • f8a8218 fix bug where '/' was not properly inserted in s3 key strings

📊 Changes

2 files changed (+21 additions, -8 deletions)

View changed files

📝 backend/open_webui/config.py (+1 -0)
📝 backend/open_webui/storage/provider.py (+20 -8)

📄 Description

discussion here

Pull Request Checklist

  • 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

Changelog Entry

  • Add support for a specific S3 object key when storing uploaded files on S3, through the S3_KEY_PREFIX environment variable.

Description

When uploading files to S3, we can only specify the following environment variables: https://docs.openwebui.com/getting-started/env-configuration/#amazon-s3-storage.
By adding a new env var we can allow users to specify a key prefix, which is the path inside of the bucket in which we want to store the file.

Changes

🔄 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/9596 **Author:** [@engineeringpatrick](https://github.com/engineeringpatrick) **Created:** 2/7/2025 **Status:** ✅ Merged **Merged:** 2/9/2025 **Merged by:** [@tjbck](https://github.com/tjbck) **Base:** `dev` ← **Head:** `main` --- ### 📝 Commits (3) - [`5ca6afc`](https://github.com/open-webui/open-webui/commit/5ca6afc0fc853411316e6db498498243e565ab81) add s3 key prefix support - [`7f82476`](https://github.com/open-webui/open-webui/commit/7f8247692685ef23e54bef781a83c96c9943876a) use key_prefix in rest of S3StorageProvider - [`f8a8218`](https://github.com/open-webui/open-webui/commit/f8a8218149d106e173cd152fd0d07479afcc17e8) fix bug where '/' was not properly inserted in s3 key strings ### 📊 Changes **2 files changed** (+21 additions, -8 deletions) <details> <summary>View changed files</summary> 📝 `backend/open_webui/config.py` (+1 -0) 📝 `backend/open_webui/storage/provider.py` (+20 -8) </details> ### 📄 Description [discussion here](https://github.com/open-webui/open-webui/discussions/9616) ### Pull Request Checklist - [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 - Add support for a specific S3 object key when storing uploaded files on S3, through the `S3_KEY_PREFIX` environment variable. ### Description When uploading files to S3, we can only specify the following environment variables: https://docs.openwebui.com/getting-started/env-configuration/#amazon-s3-storage. By adding a new env var we can allow users to specify a key prefix, which is [the path inside of the bucket](https://docs.aws.amazon.com/AmazonS3/latest/userguide/UsingObjects.html) in which we want to store the file. ### Changes - Add `S3_KEY_PREFIX` env var. - Append filename to `S3_KEY_PREFIX` when uploading files to S3. - Update docs: https://github.com/open-webui/docs/pull/386 --- <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 2026-04-20 04:06:58 -05:00
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
bug
confirmed
confirmed issue
core
documentation
enhancement
good first issue
help wanted
non-core
pull-request
Mirrored from GitHub Pull Request
 python
question
testing wanted
No Label pull-request
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
GiteaMirror ninjasurge
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: github-starred/open-webui#22391
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?