[PR #3202] [MERGED] feat: added ability to set user name for federated auth #36833

New Issue

GiteaMirror · 2026-04-25T10:33:49-05:00

GiteaMirror commented

2026-04-25 10:33:49 -05:00

📋 Pull Request Information

Original PR: https://github.com/open-webui/open-webui/pull/3202
Author: @JohnTheNerd
Created: 6/16/2024
Status: ✅ Merged
Merged: 6/17/2024
Merged by: @tjbck

Base: dev ← Head: main

📝 Commits (1)

c00a6fa added ability to set user name for federated auth

📊 Changes

3 files changed (+10 additions, -2 deletions)

View changed files

📝 backend/apps/webui/main.py (+2 -0)
📝 backend/apps/webui/routers/auths.py (+5 -2)
📝 backend/config.py (+3 -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?
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

this PR adds an optional environment variable named WEBUI_AUTH_TRUSTED_NAME_HEADER, which sets the user's name to the contents of that header. this only happens if the user is just being created, just like how the trusted e-mail header works.

if the environment variable or header is not present, we fall back to the original behavior which is to re-use the user e-mail address.

Added

Adds a new optional environment variable

Changed

None

Deprecated

None

Removed

None

Fixed

N/A

Security

N/A

Breaking Changes

N/A, it will fall back to original behavior if the header or environment variable does not exist.

Additional Information

The GitHub actions are failing due to uppercase characters in my username, so to test, I first fixed that (#3204), merged both changes in a separate branch, and merely ran the actions. The images are available in the images containing ci-cd-test in the Packages section of my fork. I deployed the resulting image to my homelab and it's working fine so far.

Documentation changes are at https://github.com/open-webui/docs/pull/117 and the discussion post is #3201 .

Screenshots or Videos

N/A

_{🔄 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/3202 **Author:** [@JohnTheNerd](https://github.com/JohnTheNerd) **Created:** 6/16/2024 **Status:** ✅ Merged **Merged:** 6/17/2024 **Merged by:** [@tjbck](https://github.com/tjbck) **Base:** `dev` ← **Head:** `main` --- ### 📝 Commits (1) - [`c00a6fa`](https://github.com/open-webui/open-webui/commit/c00a6fa02a86b92859f2b269c195436427b44f39) added ability to set user name for federated auth ### 📊 Changes **3 files changed** (+10 additions, -2 deletions) <details> <summary>View changed files</summary> 📝 `backend/apps/webui/main.py` (+2 -0) 📝 `backend/apps/webui/routers/auths.py` (+5 -2) 📝 `backend/config.py` (+3 -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 this PR adds an optional environment variable named `WEBUI_AUTH_TRUSTED_NAME_HEADER`, which sets the user's name to the contents of that header. this only happens if the user is just being created, just like how the trusted e-mail header works. if the environment variable or header is not present, we fall back to the original behavior which is to re-use the user e-mail address. ### Added - Adds a new optional environment variable ### Changed None ### Deprecated None ### Removed None ### Fixed N/A ### Security N/A ### Breaking Changes N/A, it will fall back to original behavior if the header or environment variable does not exist. --- ### Additional Information The GitHub actions are failing due to uppercase characters in my username, so to test, I first fixed that (#3204), merged both changes in a separate branch, and merely ran the actions. The images are available in the images containing `ci-cd-test` in [the Packages section of my fork](https://github.com/JohnTheNerd/open-webui/pkgs/container/open-webui/versions). I deployed the resulting image to my homelab and it's working fine so far. Documentation changes are at https://github.com/open-webui/docs/pull/117 and the discussion post is #3201 . ### Screenshots or Videos N/A --- <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-25 10:33:49 -05:00

GiteaMirror closed this issue

2026-04-25 10:33:50 -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#36833