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
Add a feature to allow administrators to configure a default background image that will be applied to all users
Added
DEFAULT_BACKGROUND_IMAGE environment variable configures a default background image used for all users
Chat Background Image option added to Interface tab on Admin Panel to allow upload or reset of the default background image for all users
Changed
The Chat interface loads the background image from the configured default background image unless a Chat Background Image is configured with the user Settings
DEFAULT_BACKGROUND_IMAGE image is a URL to an image file, e.g. /assets/images/adam.jpg
The DEFAULT_BACKGROUND_IMAGE is used for all users unless the users uploads an image with the user Settings Panel or an admin user uploads a file with the Admin Panel.
If DEFAULT_BACKGROUND_IMAGE environment variable is empty no background image will be used unless the user or admin uploads a background image with the Settings or Admin Panel.
The reset function for Chat Background Image will reset the image to the value of DEFAULT_BACKGROUND_IMAGE
NOTE: whitespace changes highlighted in the diff are not from my edits
🔄 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/10073
**Author:** [@dsewell](https://github.com/dsewell)
**Created:** 2/15/2025
**Status:** ❌ Closed
**Base:** `dev` ← **Head:** `add-default-background-image`
---
### 📝 Commits (2)
- [`0eaaf7f`](https://github.com/open-webui/open-webui/commit/0eaaf7f1e6ceccc2afb34c5300812d81c30f5568) add default background image
- [`09fac07`](https://github.com/open-webui/open-webui/commit/09fac073582ab4c698658c3f8d06e1d4ef6cf5e7) fix white space to match style of codebase
### 📊 Changes
**8 files changed** (+164 additions, -34 deletions)
<details>
<summary>View changed files</summary>
📝 `backend/open_webui/config.py` (+39 -30)
📝 `backend/open_webui/env.py` (+5 -0)
📝 `backend/open_webui/main.py` (+6 -0)
📝 `backend/open_webui/routers/configs.py` (+18 -0)
📝 `src/lib/apis/configs/index.ts` (+30 -0)
📝 `src/lib/components/admin/Settings/Interface.svelte` (+60 -0)
📝 `src/lib/components/chat/Chat.svelte` (+4 -4)
📝 `src/lib/stores/index.ts` (+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?
- [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
- Fixes #7412
- Add a feature to allow administrators to configure a default background image that will be applied to all users
### Added
- DEFAULT_BACKGROUND_IMAGE environment variable configures a default background image used for all users
- Chat Background Image option added to Interface tab on Admin Panel to allow upload or reset of the default background image for all users
### Changed
- The Chat interface loads the background image from the configured default background image unless a Chat Background Image is configured with the user Settings
- PR for docs change [here](https://github.com/open-webui/docs/pull/405)
### Deprecated
- None
### Removed
- None
### Fixed
- None
### Security
- None
### Breaking Changes
- None
---
### Additional Information
- DEFAULT_BACKGROUND_IMAGE image is a URL to an image file, e.g. /assets/images/adam.jpg
- The DEFAULT_BACKGROUND_IMAGE is used for all users unless the users uploads an image with the user Settings Panel or an admin user uploads a file with the Admin Panel.
- If DEFAULT_BACKGROUND_IMAGE environment variable is empty no background image will be used unless the user or admin uploads a background image with the Settings or Admin Panel.
- The reset function for Chat Background Image will reset the image to the value of DEFAULT_BACKGROUND_IMAGE
- NOTE: whitespace changes highlighted in the diff are not from my edits
- Fixes #7412
### Screenshots or Videos
- None
---
<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/10073
Author: @dsewell
Created: 2/15/2025
Status: ❌ Closed
Base:
dev← Head:add-default-background-image📝 Commits (2)
0eaaf7fadd default background image09fac07fix white space to match style of codebase📊 Changes
8 files changed (+164 additions, -34 deletions)
View changed files
📝
backend/open_webui/config.py(+39 -30)📝
backend/open_webui/env.py(+5 -0)📝
backend/open_webui/main.py(+6 -0)📝
backend/open_webui/routers/configs.py(+18 -0)📝
src/lib/apis/configs/index.ts(+30 -0)📝
src/lib/components/admin/Settings/Interface.svelte(+60 -0)📝
src/lib/components/chat/Chat.svelte(+4 -4)📝
src/lib/stores/index.ts(+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:
devbranch.Changelog Entry
Description
Added
Changed
Deprecated
Removed
Fixed
Security
Breaking Changes
Additional Information
Screenshots or Videos
🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.