[PR #20027] [MERGED] feat/perf: Add ENABLE_PUBLIC_ACTIVE_USERS_COUNT environment variable #41065

Closed
opened 2026-04-25 13:23:31 -05:00 by GiteaMirror · 0 comments
Owner

📋 Pull Request Information

Original PR: https://github.com/open-webui/open-webui/pull/20027
Author: @Classic298
Created: 12/18/2025
Status: Merged
Merged: 12/20/2025
Merged by: @tjbck

Base: devHead: public-user-count


📝 Commits (3)

  • 241bdbb Merge pull request open-webui#19030 from open-webui/dev (#115)
  • 470b7c7 Claude/find active user count 1ct t1 (#116)
  • 95962d7 Claude/find active user count 1ct t1 (#117)

📊 Changes

3 files changed (+30 additions, -9 deletions)

View changed files

📝 backend/open_webui/env.py (+5 -0)
📝 backend/open_webui/main.py (+11 -0)
📝 src/lib/components/layout/Sidebar/UserMenu.svelte (+14 -9)

📄 Description

Pull Request Checklist

Note to first-time contributors: Please open a discussion post in Discussions to discuss your idea/fix with the community before creating a pull request, and describe your changes before submitting a pull request.

This is to ensure large feature PRs are discussed with the community first, before starting work on it. If the community does not want this feature or it is not relevant for Open WebUI as a project, it can be identified in the discussion before working on the feature and submitting the PR.

Before submitting, make sure you've checked the following:

  • 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
    • perf: Performance improvement

Changelog Entry

Description

This PR introduces the ENABLE_PUBLIC_ACTIVE_USERS_COUNT environment variable to control visibility of the active user count indicator in the UI. When disabled, only admin users can see the active user count, while regular users cannot view it or make API requests to fetch this data.

This addresses privacy concerns and provides significant performance benefits for large deployments by eliminating unnecessary API calls to /api/usage from non-admin users.

Added

  • New environment variable: ENABLE_PUBLIC_ACTIVE_USERS_COUNT (defaults to true for backward compatibility, set it to False to prohibit users from seeing the active user count)
  • Frontend logic to conditionally display active user count based on user role and configuration
  • Config API exposure of the new setting via enable_public_active_users_count

Changed

  • Active user count API requests are now conditional based on user authorization
  • UserMenu component only fetches usage data when user has permission to view it

Additional Information

In deployments with hundreds of concurrent users, this feature can significantly reduce backend load by preventing non-admin users from making periodic API requests to /api/usage, reducing database queries and overall system noise.

Issue: #13026
Original discussion about privacy concerns and performance optimization

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.


🔄 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/20027 **Author:** [@Classic298](https://github.com/Classic298) **Created:** 12/18/2025 **Status:** ✅ Merged **Merged:** 12/20/2025 **Merged by:** [@tjbck](https://github.com/tjbck) **Base:** `dev` ← **Head:** `public-user-count` --- ### 📝 Commits (3) - [`241bdbb`](https://github.com/open-webui/open-webui/commit/241bdbb2ed0443a56e983806d6b703fa9bfe5dc8) Merge pull request open-webui#19030 from open-webui/dev (#115) - [`470b7c7`](https://github.com/open-webui/open-webui/commit/470b7c7d84a686d2631443324057450d3079ae55) Claude/find active user count 1ct t1 (#116) - [`95962d7`](https://github.com/open-webui/open-webui/commit/95962d79b388da0d767f324745b25276687804f7) Claude/find active user count 1ct t1 (#117) ### 📊 Changes **3 files changed** (+30 additions, -9 deletions) <details> <summary>View changed files</summary> 📝 `backend/open_webui/env.py` (+5 -0) 📝 `backend/open_webui/main.py` (+11 -0) 📝 `src/lib/components/layout/Sidebar/UserMenu.svelte` (+14 -9) </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) to discuss your idea/fix with the community before creating a pull request, and describe your changes before submitting a pull request. This is to ensure large feature PRs are discussed with the community first, before starting work on it. If the community does not want this feature or it is not relevant for Open WebUI as a project, it can be identified in the discussion before working on the feature and submitting the PR. **Before submitting, make sure you've checked the following:** - [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 - **perf**: Performance improvement # Changelog Entry ### Description This PR introduces the ENABLE_PUBLIC_ACTIVE_USERS_COUNT environment variable to control visibility of the active user count indicator in the UI. When disabled, only admin users can see the active user count, while regular users cannot view it or make API requests to fetch this data. This addresses privacy concerns and provides significant performance benefits for large deployments by eliminating unnecessary API calls to /api/usage from non-admin users. ### Added - New environment variable: ENABLE_PUBLIC_ACTIVE_USERS_COUNT (defaults to true for backward compatibility, set it to False to prohibit users from seeing the active user count) - Frontend logic to conditionally display active user count based on user role and configuration - Config API exposure of the new setting via enable_public_active_users_count ### Changed - Active user count API requests are now conditional based on user authorization - UserMenu component only fetches usage data when user has permission to view it --- ### Additional Information In deployments with hundreds of concurrent users, this feature can significantly reduce backend load by preventing non-admin users from making periodic API requests to /api/usage, reducing database queries and overall system noise. Issue: #13026 Original discussion about privacy concerns and performance optimization ### 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. --- <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 13:23:31 -05:00
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: github-starred/open-webui#41065