[PR #19055] feat: Admins setting custom default interface settings #11874

New Issue

GiteaMirror · 2025-11-11T19:59:19-06:00

GiteaMirror commented

2025-11-11 19:59:19 -06:00

📋 Pull Request Information

Original PR: https://github.com/open-webui/open-webui/pull/19055
Author: @Classic298
Created: 11/8/2025
Status: 🔄 Open

Base: dev ← Head: admin-interface-settings-users

📝 Commits (3)

7ee9b00 Implement message cleaning before API call
b2efa7b Claude/admin UI settings control 011 c uw3 uvo a ejtxwunu4i d1r (#26)
8fde4b8 Update Chat.svelte

📊 Changes

13 files changed (+627 additions, -73 deletions)

View changed files

📝 backend/open_webui/models/groups.py (+3 -1)
📝 backend/open_webui/routers/configs.py (+42 -0)
📝 backend/open_webui/routers/users.py (+52 -0)
📝 src/lib/apis/configs/index.ts (+57 -0)
📝 src/lib/apis/users/index.ts (+27 -0)
📝 src/lib/components/admin/Settings/Interface.svelte (+147 -0)
➕ src/lib/components/admin/Settings/Interface/InterfaceDefaultsModal.svelte (+155 -0)
📝 src/lib/components/admin/Users/Groups/EditGroupModal.svelte (+18 -3)
📝 src/lib/components/admin/Users/Groups/Permissions.svelte (+27 -1)
📝 src/lib/components/chat/Chat.svelte (+15 -14)
📝 src/lib/components/chat/Settings/Interface.svelte (+57 -51)
📝 src/lib/components/chat/SettingsModal.svelte (+9 -0)
📝 src/routes/(app)/+layout.svelte (+18 -3)

📄 Description

Target branch: Verify that the pull request targets the dev branch. Not targeting the dev branch will lead to immediate closure of the PR.
Description: Provide a concise description of the changes made in this pull request down below.
Changelog: Ensure a changelog entry following the format of Keep a Changelog is added at the bottom of the PR description.
Documentation: If necessary, update relevant documentation Open WebUI Docs like environment variables, the tutorials, or other documentation sources.
Dependencies: Are there any new dependencies? Have you updated the dependency versions in the documentation?
Testing: Perform manual tests to verify the implemented fix/feature works as intended AND does not break any other functionality. Take this as an opportunity to make screenshots of the feature/fix and include it in the PR description.
Agentic AI Code: Confirm this Pull Request is not written by any AI Agent or has at least gone through additional human review AND manual testing. If any AI Agent is the co-author of this PR, it may lead to immediate closure of the PR.
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?
Title Prefix: To clearly 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

This PR implements admin control for interface settings with global defaults, permission-based access control, and user reset functionality. Admins can now configure default interface settings (chat bubble, wide screen, RTL, etc.) that apply to all users, while maintaining granular control over which user groups can modify these settings.

Key Features:

Global admin-configurable interface defaults
Permission-based hiding of Interface Settings tab (ui.interface_settings) on a group level
Three-tier settings fallback: User custom → Admin default → System default
Reset button for users to revert ALL USERS custom interface settings to admin-configured defaults
Backward compatible with existing installations, no breaking changes

Architectural Decisions:

Interface settings are global because adding these on a group level IS NOT POSSIBLE TECHNICALLY. If a user is part of two groups with conflicting interface settings, which interface setting takes priority? These are not permissions which are additive.
Permission is group-level to allow admins to lock down the interface for specific user groups (e.g., restrict customization for external users while allowing internal users full control)
This hybrid approach balances user experience with administrative control

Testing conducted

All functional tests completed successfully:

Test 1: Admin Setting Interface Defaults (1.1-1.6)
✅ 1.1: Admin can open Interface Defaults modal from Admin Settings
✅ 1.2: Admin can configure interface defaults (Chat Bubble OFF, Wide Screen ON, Chat Direction RTL)
✅ 1.3: Defaults save successfully
✅ 1.4: Defaults persist after page refresh
✅ 1.5: Reopening modal displays current admin-configured values
✅ 1.6: Admin can modify existing defaults

Test 2: New User Receiving Admin Defaults (2.1-2.6)
✅ 2.1: Brand new user receives admin-configured defaults on first login
✅ 2.2: User can customize their own interface settings
✅ 2.3: Disabling "Interface Settings Access" permission persists correctly
✅ 2.4: User with disabled permission cannot see Interface Settings tab
✅ 2.5: User without permission still uses admin defaults for UI behavior
✅ 2.6: Re-enabling permission restores Interface Settings tab access

Test 3: User Reset Functionality (3.1-3.3)
✅ 3.1: Reset button reverts settings to admin-configured defaults
✅ 3.2: Reset confirmation dialog works correctly
✅ 3.3: UI immediately updates after reset

Test 4: Fallback Logic (4.1-4.4)
✅ 4.1: User custom settings take precedence over admin defaults
✅ 4.2: Admin defaults apply when user has no custom settings
✅ 4.3: System defaults apply when no admin defaults configured
✅ 4.4: Fallback chain maintains correct priority

Test 5: Group Permissions (5.1-5.4)
✅ 5.1: Interface Settings Access permission toggles correctly in group editor
✅ 5.2: Permission persists after closing/reopening group editor
✅ 5.3: Users in group with disabled permission cannot access Interface Settings
✅ 5.4: Users in multiple groups inherit most permissive setting

Test 6: Default User Permissions (6.1-6.3)
✅ 6.1: Interface Settings Access permission available in default permissions editor
✅ 6.2: Disabling default permission affects all new users
✅ 6.3: Changes to default permissions persist across server restarts

Test 7: Backward Compatibility (7.1-7.3)
✅ 7.1: Existing users without explicit permission have full access (default true)
✅ 7.2: Existing custom user settings preserved and take precedence
✅ 7.3: System works correctly without admin defaults configured

Test 8: Edge Cases (8.1-8.4)
✅ 8.1: Empty admin defaults handled gracefully
✅ 8.2: Partial admin defaults merge correctly with system defaults
✅ 8.3: Malformed settings data doesn't crash the UI
✅ 8.4: Rapid permission toggling doesn't cause race conditions

Contributor License Agreement

By submitting this pull request, I confirm that I have read and fully agree to the Contributor License Agreement (CLA), and I am providing my contributions under its terms.

Note

Deleting the CLA section will lead to immediate closure of your PR and it will not be merged in.
Co-authored-by: Claude noreply@anthropic.com

_{🔄 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/19055 **Author:** [@Classic298](https://github.com/Classic298) **Created:** 11/8/2025 **Status:** 🔄 Open **Base:** `dev` ← **Head:** `admin-interface-settings-users` --- ### 📝 Commits (3) - [`7ee9b00`](https://github.com/open-webui/open-webui/commit/7ee9b0090af5cc77f2fd6a3bb8f6dbe70bf6f06f) Implement message cleaning before API call - [`b2efa7b`](https://github.com/open-webui/open-webui/commit/b2efa7b6c93c65b8b7341c0aea53c3bdbee21777) Claude/admin UI settings control 011 c uw3 uvo a ejtxwunu4i d1r (#26) - [`8fde4b8`](https://github.com/open-webui/open-webui/commit/8fde4b86f0509166ee4925a07ae2e1f477f6ea32) Update Chat.svelte ### 📊 Changes **13 files changed** (+627 additions, -73 deletions) <details> <summary>View changed files</summary> 📝 `backend/open_webui/models/groups.py` (+3 -1) 📝 `backend/open_webui/routers/configs.py` (+42 -0) 📝 `backend/open_webui/routers/users.py` (+52 -0) 📝 `src/lib/apis/configs/index.ts` (+57 -0) 📝 `src/lib/apis/users/index.ts` (+27 -0) 📝 `src/lib/components/admin/Settings/Interface.svelte` (+147 -0) ➕ `src/lib/components/admin/Settings/Interface/InterfaceDefaultsModal.svelte` (+155 -0) 📝 `src/lib/components/admin/Users/Groups/EditGroupModal.svelte` (+18 -3) 📝 `src/lib/components/admin/Users/Groups/Permissions.svelte` (+27 -1) 📝 `src/lib/components/chat/Chat.svelte` (+15 -14) 📝 `src/lib/components/chat/Settings/Interface.svelte` (+57 -51) 📝 `src/lib/components/chat/SettingsModal.svelte` (+9 -0) 📝 `src/routes/(app)/+layout.svelte` (+18 -3) </details> ### 📄 Description - [X] **Target branch:** Verify that the pull request targets the `dev` branch. **Not targeting the `dev` branch will lead to immediate closure of the PR.** - [X] **Description:** Provide a concise description of the changes made in this pull request down below. - [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:** If necessary, update relevant documentation [Open WebUI Docs](https://github.com/open-webui/docs) like environment variables, the tutorials, or other documentation sources. - [X] **Dependencies:** Are there any new dependencies? Have you updated the dependency versions in the documentation? - [X] **Testing:** Perform manual tests to **verify the implemented fix/feature works as intended AND does not break any other functionality**. Take this as an opportunity to **make screenshots of the feature/fix and include it in the PR description**. - [X] **Agentic AI Code:** Confirm this Pull Request is **not written by any AI Agent** or has at least **gone through additional human review AND manual testing**. If any AI Agent is the co-author of this PR, it may lead to immediate closure of the PR. - [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] **Title Prefix:** To clearly 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 This PR implements admin control for interface settings with global defaults, permission-based access control, and user reset functionality. Admins can now configure default interface settings (chat bubble, wide screen, RTL, etc.) that apply to all users, while maintaining granular control over which user groups can modify these settings. Key Features: - Global admin-configurable interface defaults - Permission-based hiding of Interface Settings tab (ui.interface_settings) on a group level - Three-tier settings fallback: User custom → Admin default → System default - Reset button for users to revert ALL USERS custom interface settings to admin-configured defaults - Backward compatible with existing installations, no breaking changes Architectural Decisions: - Interface settings are global because adding these on a group level IS NOT POSSIBLE TECHNICALLY. If a user is part of two groups with conflicting interface settings, which interface setting takes priority? These are not permissions which are additive. - Permission is group-level to allow admins to lock down the interface for specific user groups (e.g., restrict customization for external users while allowing internal users full control) - This hybrid approach balances user experience with administrative control ### Testing conducted All functional tests completed successfully: Test 1: Admin Setting Interface Defaults (1.1-1.6) ✅ 1.1: Admin can open Interface Defaults modal from Admin Settings ✅ 1.2: Admin can configure interface defaults (Chat Bubble OFF, Wide Screen ON, Chat Direction RTL) ✅ 1.3: Defaults save successfully ✅ 1.4: Defaults persist after page refresh ✅ 1.5: Reopening modal displays current admin-configured values ✅ 1.6: Admin can modify existing defaults Test 2: New User Receiving Admin Defaults (2.1-2.6) ✅ 2.1: Brand new user receives admin-configured defaults on first login ✅ 2.2: User can customize their own interface settings ✅ 2.3: Disabling "Interface Settings Access" permission persists correctly ✅ 2.4: User with disabled permission cannot see Interface Settings tab ✅ 2.5: User without permission still uses admin defaults for UI behavior ✅ 2.6: Re-enabling permission restores Interface Settings tab access Test 3: User Reset Functionality (3.1-3.3) ✅ 3.1: Reset button reverts settings to admin-configured defaults ✅ 3.2: Reset confirmation dialog works correctly ✅ 3.3: UI immediately updates after reset Test 4: Fallback Logic (4.1-4.4) ✅ 4.1: User custom settings take precedence over admin defaults ✅ 4.2: Admin defaults apply when user has no custom settings ✅ 4.3: System defaults apply when no admin defaults configured ✅ 4.4: Fallback chain maintains correct priority Test 5: Group Permissions (5.1-5.4) ✅ 5.1: Interface Settings Access permission toggles correctly in group editor ✅ 5.2: Permission persists after closing/reopening group editor ✅ 5.3: Users in group with disabled permission cannot access Interface Settings ✅ 5.4: Users in multiple groups inherit most permissive setting Test 6: Default User Permissions (6.1-6.3) ✅ 6.1: Interface Settings Access permission available in default permissions editor ✅ 6.2: Disabling default permission affects all new users ✅ 6.3: Changes to default permissions persist across server restarts Test 7: Backward Compatibility (7.1-7.3) ✅ 7.1: Existing users without explicit permission have full access (default true) ✅ 7.2: Existing custom user settings preserved and take precedence ✅ 7.3: System works correctly without admin defaults configured Test 8: Edge Cases (8.1-8.4) ✅ 8.1: Empty admin defaults handled gracefully ✅ 8.2: Partial admin defaults merge correctly with system defaults ✅ 8.3: Malformed settings data doesn't crash the UI ✅ 8.4: Rapid permission toggling doesn't cause race conditions ### Contributor License Agreement By submitting this pull request, I confirm that I have read and fully agree to the [Contributor License Agreement (CLA)](https://github.com/open-webui/open-webui/blob/main/CONTRIBUTOR_LICENSE_AGREEMENT), and I am providing my contributions under its terms. > [!NOTE] > Deleting the CLA section will lead to immediate closure of your PR and it will not be merged in. Co-authored-by: Claude <noreply@anthropic.com> --- <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 19:59:19 -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#11874