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? Will done after this PR reviewed.
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:
feat: Introduces a new feature or enhancement to the codebase
🔄 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/8624
**Author:** [@Tryanks](https://github.com/Tryanks)
**Created:** 1/16/2025
**Status:** ❌ Closed
**Base:** `dev` ← **Head:** `oauth-github`
---
### 📝 Commits (2)
- [`4b6700a`](https://github.com/open-webui/open-webui/commit/4b6700a4b21347733fe83d22256406605137539e) fixed: incorrectly indexing the key userinfo in the token.
- [`e3d09e1`](https://github.com/open-webui/open-webui/commit/e3d09e1b52c9f4195eb27cc3d942494cc96d9b77) enh: add github oauth2 provider support
### 📊 Changes
**3 files changed** (+67 additions, -1 deletions)
<details>
<summary>View changed files</summary>
📝 `backend/open_webui/config.py` (+32 -0)
📝 `backend/open_webui/utils/oauth.py` (+19 -1)
📝 `src/routes/auth/+page.svelte` (+16 -0)
</details>
### 📄 Description
# Pull Request Checklist
**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.
- [ ] **Documentation:** Have you updated relevant documentation [Open WebUI Docs](https://github.com/open-webui/docs), or other documentation sources? **Will done after this PR reviewed.**
- [ ] **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?
- [ ] **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:
- **feat**: Introduces a new feature or enhancement to the codebase
# Changelog Entry
### Description
Address #8614
Add support for SSO login with Github.
Env vars:
- `GITHUB_CLIENT_ID` - Github OAuth App Client ID
- `GITHUB_CLIENT_SECRET` - Github OAuth App Client Secret
- `GITHUB_OAUTH_SCOPE` - Github OAuth App Scope, default "user:email"
### Added
- Github OAuth2 Provider in SSO.
---
<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/8624
Author: @Tryanks
Created: 1/16/2025
Status: ❌ Closed
Base:
dev← Head:oauth-github📝 Commits (2)
4b6700afixed: incorrectly indexing the key userinfo in the token.e3d09e1enh: add github oauth2 provider support📊 Changes
3 files changed (+67 additions, -1 deletions)
View changed files
📝
backend/open_webui/config.py(+32 -0)📝
backend/open_webui/utils/oauth.py(+19 -1)📝
src/routes/auth/+page.svelte(+16 -0)📄 Description
Pull Request Checklist
Before submitting, make sure you've checked the following:
devbranch.Changelog Entry
Description
Address #8614
Add support for SSO login with Github.
Env vars:
GITHUB_CLIENT_ID- Github OAuth App Client IDGITHUB_CLIENT_SECRET- Github OAuth App Client SecretGITHUB_OAUTH_SCOPE- Github OAuth App Scope, default "user:email"Added
🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.