[PR #15380] [MERGED] feat: Support configuration of redis key prefix via environment variable #46854

New Issue

GiteaMirror · 2026-04-29T21:49:19-05:00

GiteaMirror commented

2026-04-29 21:49:19 -05:00

📋 Pull Request Information

Original PR: https://github.com/open-webui/open-webui/pull/15380
Author: @taylorwilsdon
Created: 6/28/2025
Status: ✅ Merged
Merged: 6/30/2025
Merged by: @tjbck

Base: dev ← Head: issues/15074/REDIS_KEY_PREFIX

📝 Commits (2)

345922a add REDIS_KEY_PREFIX env var and default to current hardcoded value
7b5df81 fmt

📊 Changes

3 files changed (+12 additions, -3 deletions)

View changed files

📝 backend/open_webui/config.py (+9 -3)
📝 backend/open_webui/env.py (+1 -0)
📝 backend/open_webui/main.py (+2 -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:

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? - doc PR to follow
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

Add support for configurable Redis key prefixes through the new REDIS_KEY_PREFIX environment variable. This allows users to customize the Redis key namespace while maintaining backward compatibility with the default "open-webui" prefix.

Added

New REDIS_KEY_PREFIX environment variable that allows customization of Redis key prefixes
Support for configurable Redis key prefixes in the AppConfig class
Default value of "open-webui" maintains backward compatibility

Changed

Modified AppConfig.init() method to accept redis_key_prefix parameter
Updated Redis key construction in setattr and getattr methods to use configurable prefix
Enhanced imports in config.py and main.py to include REDIS_KEY_PREFIX

Deprecated

[List any deprecated functionality or features that have been removed]

Removed

[List any removed features, files, or functionalities]

Fixed

[List any fixes, corrections, or bug fixes]

Security

[List any new or updated security-related changes, including vulnerability fixes]

Breaking Changes

BREAKING CHANGE: [List any breaking changes affecting compatibility or functionality]

Additional Information

Implementation follows the existing pattern used by REDIS_URL environment variable
Users can now set REDIS_KEY_PREFIX="{open-webui}" to customize Redis keys from open-webui:config:{key} to {open-webui}:config:{key}
Without setting the environment variable, behavior remains unchanged (uses "open-webui" prefix)
Changes span across four files: env.py, config.py, and main.py
Related to issue [GH-ISSUE #8296] `docker compose build` fails (#15074)

Screenshots or Videos

n/a

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/15380 **Author:** [@taylorwilsdon](https://github.com/taylorwilsdon) **Created:** 6/28/2025 **Status:** ✅ Merged **Merged:** 6/30/2025 **Merged by:** [@tjbck](https://github.com/tjbck) **Base:** `dev` ← **Head:** `issues/15074/REDIS_KEY_PREFIX` --- ### 📝 Commits (2) - [`345922a`](https://github.com/open-webui/open-webui/commit/345922a970ce708fac229be390ffe3cb49aecac3) add REDIS_KEY_PREFIX env var and default to current hardcoded value - [`7b5df81`](https://github.com/open-webui/open-webui/commit/7b5df819b1ced62a871849c73e79d5e110594292) fmt ### 📊 Changes **3 files changed** (+12 additions, -3 deletions) <details> <summary>View changed files</summary> 📝 `backend/open_webui/config.py` (+9 -3) 📝 `backend/open_webui/env.py` (+1 -0) 📝 `backend/open_webui/main.py` (+2 -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? - doc PR to follow - [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 - Add support for configurable Redis key prefixes through the new REDIS_KEY_PREFIX environment variable. This allows users to customize the Redis key namespace while maintaining backward compatibility with the default "open-webui" prefix. ### Added - New REDIS_KEY_PREFIX environment variable that allows customization of Redis key prefixes - Support for configurable Redis key prefixes in the AppConfig class - Default value of "open-webui" maintains backward compatibility ### Changed - Modified AppConfig.__init__() method to accept redis_key_prefix parameter - Updated Redis key construction in __setattr__ and __getattr__ methods to use configurable prefix - Enhanced imports in config.py and main.py to include REDIS_KEY_PREFIX ### Deprecated - [List any deprecated functionality or features that have been removed] ### Removed - [List any removed features, files, or functionalities] ### Fixed - [List any fixes, corrections, or bug fixes] ### Security - [List any new or updated security-related changes, including vulnerability fixes] ### Breaking Changes - **BREAKING CHANGE**: [List any breaking changes affecting compatibility or functionality] --- ### Additional Information - Implementation follows the existing pattern used by REDIS_URL environment variable - Users can now set REDIS_KEY_PREFIX="{open-webui}" to customize Redis keys from open-webui:config:{key} to {open-webui}:config:{key} - Without setting the environment variable, behavior remains unchanged (uses "open-webui" prefix) - Changes span across four files: env.py, config.py, and main.py - Related to issue #15074 ### Screenshots or Videos n/a ### 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 2026-04-29 21:49:19 -05:00

GiteaMirror closed this issue

2026-04-29 21:49:21 -05:00

Sign in to join this conversation.

Branches Tags

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: github-starred/open-webui#46854