[PR #6589] [MERGED] feat: Add option to forward user info as headers to OpenAI API #8709

New Issue

GiteaMirror · 2025-11-11T18:03:47-06:00

GiteaMirror commented

2025-11-11 18:03:47 -06:00

📋 Pull Request Information

Original PR: https://github.com/open-webui/open-webui/pull/6589
Author: @DucNgn
Created: 10/30/2024
Status: ✅ Merged
Merged: 11/3/2024
Merged by: @tjbck

Base: dev ← Head: dn_forward_user_info_in_headers

📝 Commits (3)

3f0b3ea feat: Add option to forward user info as headers to OpenAI API
a34d202 move the config to env.py
06f44dc Minor comment

📊 Changes

5 files changed (+45 additions, -2 deletions)

View changed files

📝 backend/open_webui/apps/audio/main.py (+7 -1)
📝 backend/open_webui/apps/images/main.py (+7 -1)
📝 backend/open_webui/apps/openai/main.py (+21 -0)
📝 backend/open_webui/config.py (+1 -0)
📝 backend/open_webui/env.py (+9 -0)

📄 Description

Pull Request Checklist

This PR is following up on this discussion: https://github.com/open-webui/open-webui/discussions/6036
Docs Change: https://github.com/open-webui/docs/pull/259

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

Feature: Forward User Information as Headers to OpenAI-Compatible API

Added

A configuration called OPENAI_FORWARD_USER_INFO_AS_HEADERS , when enabled would forward user information to OpenAI-compatible Backend with user's information: name, email, id, and role. By default, this is disabled. Users could enable it using 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/6589 **Author:** [@DucNgn](https://github.com/DucNgn) **Created:** 10/30/2024 **Status:** ✅ Merged **Merged:** 11/3/2024 **Merged by:** [@tjbck](https://github.com/tjbck) **Base:** `dev` ← **Head:** `dn_forward_user_info_in_headers` --- ### 📝 Commits (3) - [`3f0b3ea`](https://github.com/open-webui/open-webui/commit/3f0b3ea90e6dc0a9e8a8bde302412d45c4d5f4eb) feat: Add option to forward user info as headers to OpenAI API - [`a34d202`](https://github.com/open-webui/open-webui/commit/a34d202ae8b37a563e42f3ce5f5258c9cf5e4055) move the config to env.py - [`06f44dc`](https://github.com/open-webui/open-webui/commit/06f44dc0670d918bacfd172298d8f9fb2c23c4db) Minor comment ### 📊 Changes **5 files changed** (+45 additions, -2 deletions) <details> <summary>View changed files</summary> 📝 `backend/open_webui/apps/audio/main.py` (+7 -1) 📝 `backend/open_webui/apps/images/main.py` (+7 -1) 📝 `backend/open_webui/apps/openai/main.py` (+21 -0) 📝 `backend/open_webui/config.py` (+1 -0) 📝 `backend/open_webui/env.py` (+9 -0) </details> ### 📄 Description # Pull Request Checklist This PR is following up on this discussion: https://github.com/open-webui/open-webui/discussions/6036 Docs Change: https://github.com/open-webui/docs/pull/259 **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 - Feature: Forward User Information as Headers to OpenAI-Compatible API ### Added - A configuration called `OPENAI_FORWARD_USER_INFO_AS_HEADERS `, when enabled would forward user information to OpenAI-compatible Backend with user's information: name, email, id, and role. By default, this is disabled. Users could enable it using environment variable. --- <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 2025-11-11 18:03:47 -06:00

GiteaMirror closed this issue

2025-11-11 18:03:47 -06: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#8709