Note: to make this work, you have to escape the quote in your .env file. Example:
WEBUI_BANNERS="[{\"id\": \"1\", \"type\": \"warning\", \"title\": \"Your messages are stored.\", \"content\": \"Your messages are stored and may be reviewed by human people. LLM's are prone to hallucinations, check sources.\", \"dismissible\": true, \"timestamp\": 1000}]"
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
Changelog Entry
Description
Remove unused dependencies in config.py.
Parse banners config from environment if set.
Fixed
Fix WEBUI_BANNERS environment variable
🔄 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/3591
**Author:** [@michaelpoluektov](https://github.com/michaelpoluektov)
**Created:** 7/2/2024
**Status:** ✅ Merged
**Merged:** 7/2/2024
**Merged by:** [@tjbck](https://github.com/tjbck)
**Base:** `dev` ← **Head:** `fix-banners-env`
---
### 📝 Commits (2)
- [`16fa454`](https://github.com/open-webui/open-webui/commit/16fa45455850a8218e0c0d63f96ff8733900318c) fix banners env
- [`655238d`](https://github.com/open-webui/open-webui/commit/655238dcd7b71e43c7f48e30d8e7e51c56904084) banners: generic exception
### 📊 Changes
**1 file changed** (+8 additions, -8 deletions)
<details>
<summary>View changed files</summary>
📝 `backend/config.py` (+8 -8)
</details>
### 📄 Description
# Pull Request Checklist
Fixes the environment variable documented here: https://docs.openwebui.com/getting-started/env-configuration#webui_banners
Note: to make this work, you have to escape the quote in your `.env` file. Example:
```sh
WEBUI_BANNERS="[{\"id\": \"1\", \"type\": \"warning\", \"title\": \"Your messages are stored.\", \"content\": \"Your messages are stored and may be reviewed by human people. LLM's are prone to hallucinations, check sources.\", \"dismissible\": true, \"timestamp\": 1000}]"
```
**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?
- [ ] **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
- Remove unused dependencies in `config.py`.
- Parse banners config from environment if set.
### Fixed
- Fix `WEBUI_BANNERS` environment variable
---
<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/3591
Author: @michaelpoluektov
Created: 7/2/2024
Status: ✅ Merged
Merged: 7/2/2024
Merged by: @tjbck
Base:
dev← Head:fix-banners-env📝 Commits (2)
16fa454fix banners env655238dbanners: generic exception📊 Changes
1 file changed (+8 additions, -8 deletions)
View changed files
📝
backend/config.py(+8 -8)📄 Description
Pull Request Checklist
Fixes the environment variable documented here: https://docs.openwebui.com/getting-started/env-configuration#webui_banners
Note: to make this work, you have to escape the quote in your
.envfile. Example:Before submitting, make sure you've checked the following:
devbranch.Changelog Entry
Description
config.py.Fixed
WEBUI_BANNERSenvironment variable🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.