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
Environ variable OAUTH_USERNAME_CLAIM for set username claim from OAuth.
Environ variable OAUTH_PICTURE_CLAIM for set avatar url claim from OAuth.
Additional Information
[Insert any additional context, notes, or explanations for the changes]
[Reference any related issues, commits, or other relevant information]
🔄 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/3569
**Author:** [@Semihal](https://github.com/Semihal)
**Created:** 7/1/2024
**Status:** ✅ Merged
**Merged:** 7/3/2024
**Merged by:** [@tjbck](https://github.com/tjbck)
**Base:** `dev` ← **Head:** `custom-openid-claims`
---
### 📝 Commits (5)
- [`0c3f9a1`](https://github.com/open-webui/open-webui/commit/0c3f9a16e3c3ecd882b69bea2363902889a3c4c8) custom env for set custom claims for openid
- [`9f32e9e`](https://github.com/open-webui/open-webui/commit/9f32e9ef602fdb25e69a95d41ae4a96358ed88f2) fix username claim
- [`6e934c2`](https://github.com/open-webui/open-webui/commit/6e934c2d17e5d1c9367e287b10cbcc21625c3d6e) Merge branch 'refs/heads/main' into custom-openid-claims
- [`e475f02`](https://github.com/open-webui/open-webui/commit/e475f025b74250213b71b4c4853bfeae66573890) fix: merge request fail (remove picture_claim)
- [`a94c7e5`](https://github.com/open-webui/open-webui/commit/a94c7e5c0973811b82ff8443220286525d0b1929) fix lint
### 📊 Changes
**3 files changed** (+21 additions, -2 deletions)
<details>
<summary>View changed files</summary>
📝 `backend/apps/webui/main.py` (+5 -0)
📝 `backend/config.py` (+12 -0)
📝 `backend/main.py` (+4 -2)
</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
The ability to use custom names obtained with OAuth (OpenID) for the username and picture (avatar) fields.
Documentation PR: https://github.com/open-webui/docs/pull/144.
### Added
- Environ variable `OAUTH_USERNAME_CLAIM` for set username claim from OAuth.
- Environ variable `OAUTH_PICTURE_CLAIM` for set avatar url claim from OAuth.
---
### Additional Information
- [Insert any additional context, notes, or explanations for the changes]
- [Reference any related issues, commits, or other relevant information]
---
<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/3569
Author: @Semihal
Created: 7/1/2024
Status: ✅ Merged
Merged: 7/3/2024
Merged by: @tjbck
Base:
dev← Head:custom-openid-claims📝 Commits (5)
0c3f9a1custom env for set custom claims for openid9f32e9efix username claim6e934c2Merge branch 'refs/heads/main' into custom-openid-claimse475f02fix: merge request fail (remove picture_claim)a94c7e5fix lint📊 Changes
3 files changed (+21 additions, -2 deletions)
View changed files
📝
backend/apps/webui/main.py(+5 -0)📝
backend/config.py(+12 -0)📝
backend/main.py(+4 -2)📄 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
The ability to use custom names obtained with OAuth (OpenID) for the username and picture (avatar) fields.
Documentation PR: https://github.com/open-webui/docs/pull/144.
Added
OAUTH_USERNAME_CLAIMfor set username claim from OAuth.OAUTH_PICTURE_CLAIMfor set avatar url claim from OAuth.Additional Information
🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.