Skip to content

A dashboard for tracking user activity and enforcing usage limits in OpenWebUI. Set user quotas efficiently.

License

Notifications You must be signed in to change notification settings

hanka777/OpenWebUIMonitor

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

68 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

OpenWebUI Monitor

A monitoring dashboard for OpenWebUI that tracks usage and manages user balances. Simply add a function to OpenWebUI to view user activity and balances in a unified panel.

Features

  • Set prices for each model in OpenWebUI;
  • Set balance for each user, deduct based on token consumption and model prices, with notifications at the end of each chat;
  • View user data and visualizations;
  • One-click test for all model availability.

Deployment

Deploy Server

Vercel Deployment

Deploy on Vercel

After deployment, go to Storage -> Create Database to select and connect Neon Postgres. You'll also need to go to Settings -> Environment Variables to add environment variables as described below. Finally, redeploy the project. Once successfully deployed, you'll get a domain name that needs to be added to the OpenWebUI function plugin.

Docker Deployment

Copy and fill in the environment variables according to the requirements below.

cp .env.example .env
vi .env

Then run in the project root directory

sudo docker compose up -d --build

If you need to modify the project running port, please edit docker-compose.yml.

Install OpenWebUI Function Plugin

Add this OpenWebUI-Monitor function to OpenWebUI functions. After adding, click on function settings to configure the API endpoint and API key.

Environment Variables

Variable Name Description Example
INIT_BALANCE Initial user balance 1.14
OPENWEBUI_DOMAIN OpenWebUI domain https://chat.example.com
OPENWEBUI_API_KEY OpenWebUI API Key, found in Personal Settings -> Account -> API Key owui-xxxxxxxxxxxxxxxx
API_KEY For API request verification your-api-key-here
ACCESS_TOKEN For page access verification your-access-token-here

Ensure to generate strong API_KEY and ACCESS_TOKEN, you can use 1Password to generate them online.

Gallery

Gallery Image 1
Gallery Image 2
Gallery Image 3
Gallery Image 4
Gallery Image 5

About

A dashboard for tracking user activity and enforcing usage limits in OpenWebUI. Set user quotas efficiently.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 92.2%
  • Python 4.9%
  • CSS 1.5%
  • Other 1.4%