github-starred/open-webui
2
0
Fork 0
mirror of https://github.com/open-webui/open-webui.git synced 2026-03-22 14:13:08 -05:00
Code Issues 308 Packages Projects Releases 100 Wiki Activity

[PR #6950] [CLOSED] feat: Ability to configure the use of private API keys in an environment #8779

New Issue
Closed
opened 2025-11-11 18:05:48 -06:00 by GiteaMirror · 0 comments
GiteaMirror commented 2025-11-11 18:05:48 -06:00
Owner
Copy Link

📋 Pull Request Information

Original PR: https://github.com/open-webui/open-webui/pull/6950
Author: @antpyykk-kone
Created: 11/14/2024
Status: ❌ Closed

Base: dev ← Head: feature/config-private-api-key-use

📝 Commits (2)

  • a9ccac4 feat: support for configuring private api key use
  • ca4baf8 i18n: add translations for api key use

📊 Changes

52 files changed (+152 additions, -79 deletions)

View changed files

📝 backend/open_webui/apps/webui/main.py (+2 -0)
📝 backend/open_webui/apps/webui/routers/auths.py (+6 -1)
📝 backend/open_webui/config.py (+6 -0)
📝 backend/open_webui/constants.py (+2 -0)
📝 backend/open_webui/main.py (+1 -0)
📝 backend/open_webui/utils/utils.py (+4 -0)
📝 src/lib/components/chat/Settings/Account.svelte (+86 -78)
📝 src/lib/i18n/locales/ar-BH/translation.json (+1 -0)
📝 src/lib/i18n/locales/bg-BG/translation.json (+1 -0)
📝 src/lib/i18n/locales/bn-BD/translation.json (+1 -0)
📝 src/lib/i18n/locales/ca-ES/translation.json (+1 -0)
📝 src/lib/i18n/locales/ceb-PH/translation.json (+1 -0)
📝 src/lib/i18n/locales/da-DK/translation.json (+1 -0)
📝 src/lib/i18n/locales/de-DE/translation.json (+1 -0)
📝 src/lib/i18n/locales/dg-DG/translation.json (+1 -0)
📝 src/lib/i18n/locales/en-GB/translation.json (+1 -0)
📝 src/lib/i18n/locales/en-US/translation.json (+1 -0)
📝 src/lib/i18n/locales/es-ES/translation.json (+1 -0)
📝 src/lib/i18n/locales/fa-IR/translation.json (+1 -0)
📝 src/lib/i18n/locales/fi-FI/translation.json (+1 -0)

...and 32 more files

📄 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

  • Introduce a configuration option to disable private API key use and generation in an environment. When disabled, only JWT can be used to authenticate, helping to prevent potential misuse. By default private API keys are still enabled.

Added

  • A new configuration option ENABLE_API_KEY_AUTH to control private API key use in an environment.

Changed

  • Prevent authentication using API key, if ENABLE_API_KEY_AUTH config is disabled
  • Prevent creation of API keys, if ENABLE_API_KEY_AUTH config is disabled
  • Hide UI section for managing API keys (under Settings > Account), if ENABLE_API_KEY_AUTH config is disabled

Additional Information

  • Discussion for this functionality was started in #6756
  • A slight overlap with discussed functionality in #6692

Screenshots or Videos

Screenshot showcasing disabled API key usage

🔄 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/6950 **Author:** [@antpyykk-kone](https://github.com/antpyykk-kone) **Created:** 11/14/2024 **Status:** ❌ Closed **Base:** `dev` ← **Head:** `feature/config-private-api-key-use` --- ### 📝 Commits (2) - [`a9ccac4`](https://github.com/open-webui/open-webui/commit/a9ccac4ffd049e06e575b50195b35c8acfafdf17) feat: support for configuring private api key use - [`ca4baf8`](https://github.com/open-webui/open-webui/commit/ca4baf82fb55e7529936431d24ac0b089bccfe4a) i18n: add translations for api key use ### 📊 Changes **52 files changed** (+152 additions, -79 deletions) <details> <summary>View changed files</summary> 📝 `backend/open_webui/apps/webui/main.py` (+2 -0) 📝 `backend/open_webui/apps/webui/routers/auths.py` (+6 -1) 📝 `backend/open_webui/config.py` (+6 -0) 📝 `backend/open_webui/constants.py` (+2 -0) 📝 `backend/open_webui/main.py` (+1 -0) 📝 `backend/open_webui/utils/utils.py` (+4 -0) 📝 `src/lib/components/chat/Settings/Account.svelte` (+86 -78) 📝 `src/lib/i18n/locales/ar-BH/translation.json` (+1 -0) 📝 `src/lib/i18n/locales/bg-BG/translation.json` (+1 -0) 📝 `src/lib/i18n/locales/bn-BD/translation.json` (+1 -0) 📝 `src/lib/i18n/locales/ca-ES/translation.json` (+1 -0) 📝 `src/lib/i18n/locales/ceb-PH/translation.json` (+1 -0) 📝 `src/lib/i18n/locales/da-DK/translation.json` (+1 -0) 📝 `src/lib/i18n/locales/de-DE/translation.json` (+1 -0) 📝 `src/lib/i18n/locales/dg-DG/translation.json` (+1 -0) 📝 `src/lib/i18n/locales/en-GB/translation.json` (+1 -0) 📝 `src/lib/i18n/locales/en-US/translation.json` (+1 -0) 📝 `src/lib/i18n/locales/es-ES/translation.json` (+1 -0) 📝 `src/lib/i18n/locales/fa-IR/translation.json` (+1 -0) 📝 `src/lib/i18n/locales/fi-FI/translation.json` (+1 -0) _...and 32 more files_ </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. - [ ] **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? - [ ] **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 - Introduce a configuration option to disable private API key use and generation in an environment. When disabled, only JWT can be used to authenticate, helping to prevent potential misuse. By default private API keys are still enabled. ### Added - A new configuration option `ENABLE_API_KEY_AUTH` to control private API key use in an environment. ### Changed - Prevent authentication using API key, if `ENABLE_API_KEY_AUTH` config is disabled - Prevent creation of API keys, if `ENABLE_API_KEY_AUTH` config is disabled - Hide UI section for managing API keys (under Settings > Account), if `ENABLE_API_KEY_AUTH` config is disabled --- ### Additional Information - Discussion for this functionality was started in #6756 - A slight overlap with discussed functionality in #6692 ### Screenshots or Videos ![Screenshot showcasing disabled API key usage](https://github.com/user-attachments/assets/010232b5-544b-4484-b4c0-fef1d93525a5) --- <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:05:48 -06:00
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
bug
core
documentation
enhancement
good first issue
help wanted
non-core
pull-request
Mirrored from GitHub Pull Request
 python
question
testing wanted
No Label pull-request
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
GiteaMirror ninjasurge
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: github-starred/open-webui#8779
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?