Skip to content

Repository files navigation

Usage Dashboard logo

Usage Dashboard

Self-hosted provider usage dashboard for Firecrawl, DeepSeek, OpenAI, Anthropic/Claude, OpenRouter, OpenAI Codex, OpenCode Go, and custom HTTP endpoints. It tracks current quota and health, retains history, analyzes cost and value, attributes Hermes-observed workload by provider/model/profile, stores provider credentials encrypted at rest, and exposes integrations for Homepage Dashboard and the browser extension.

Support me on Ko-fi

Usage Dashboard screenshot

Documentation

Full documentation lives in the documentation site. Start with Installation options to compare Docker Compose, native Linux, and standalone containers.

Quick start

Start from a machine with Git and Docker Compose installed. This path uses the published containers, so you do not need to build anything locally.

git clone https://github.com/Skulldorom/usage-dashboard.git
cd usage-dashboard
cp .env.example .env
openssl rand -base64 32 | tr '+/' '-_'

Copy the generated value into ENCRYPTION_KEY in .env, replacing replace-with-generated-fernet-key. Then start the stack:

docker compose pull
docker compose up -d
docker compose logs backend

Open the frontend, then use the one-time setup code from the backend logs to create the admin password.

See the complete Docker Compose guide and First-run setup. Native Linux and standalone-container production deployments are documented under Installation options.

Features

  • 🔐 Provider credentials encrypted at rest with Fernet.
  • 📊 Current quota, balance, usage history, forecasts, and provider health for eight provider types.
  • 💵 PAYG and subscription cost accounting with explicit provenance and pricing coverage.
  • 🧭 Hermes workload attribution by provider, model, profile, request, and session.
  • 🏠 Homepage Dashboard widget with dynamic per-provider rows.
  • 🧩 Chrome/Brave browser extension with one-click setup.
  • 🔔 Alert thresholds and automatic background polling.

Stack

  • Backend: FastAPI, SQLAlchemy async, asyncpg, Alembic, cryptography/Fernet
  • Frontend: Vite, React, MUI, React Router
  • Runtime: PostgreSQL, Uvicorn, production Vite assets, nginx, and optional Docker Compose

Development

Local source setup is a development workflow, not a production installation. See Local development for the Vite dev server and test commands.

License

Mozilla Public License 2.0

About

A dashboard that lets users register and see thier current usage for multiple providers at once

Resources

Stars

4 stars

Watchers

0 watching

Forks

Packages

Used by

Contributors

Languages