# Keyosk

> Keyosk is your self-service counter for local AI: log in and get your LiteLLM API key in seconds.

Keyosk is a self-hosted web app that issues personal LiteLLM API keys. People
log in through an OIDC provider and generate, extend or delete their own key;
administrators assign profiles that set the models, rate limits, spend quotas
and key validity. Keyosk needs an existing OIDC provider and a LiteLLM gateway
(v1.105.0 or later), and is configured with environment variables. It runs as
one container with a SQLite database.

## Documentation

- [Getting started](<https://virtuos.github.io/keyosk/getting-started/index.md>): What Keyosk does, and the commands to try it locally or against your own gateway and identity provider
- [Installation](<https://virtuos.github.io/keyosk/installation/index.md>): Running Keyosk with Docker Compose: the settings to make, the first admin, backups and updates
- [Configuration](<https://virtuos.github.io/keyosk/configuration/index.md>): Every environment variable with its default, and how to register the OIDC client
- [Administrators](<https://virtuos.github.io/keyosk/administrators/index.md>): Who is an admin: members of an identity-provider group (ADMIN_GROUP) or accounts marked in the database, with IdP-specific notes
- [Monitoring](<https://virtuos.github.io/keyosk/monitoring/index.md>): The Prometheus metrics, the bearer token for /metrics, suggested alerts, and the health check endpoints

## Concepts

- [Key usage limits](<https://virtuos.github.io/keyosk/concepts/usage-limits/index.md>): Spend quotas per period, how LiteLLM enforces them (422 vs 429), and what the usage dashboard shows
- [Key expiration](<https://virtuos.github.io/keyosk/concepts/expiration/index.md>): How extending a key works and when expiry warnings go out by dashboard and email
- [Profiles](<https://virtuos.github.io/keyosk/concepts/profiles/index.md>): Profile fields, assigning profiles with deadlines, how changes reach existing keys, and keys deleted in the gateway
- [The LiteLLM gateway](<https://virtuos.github.io/keyosk/concepts/gateway/index.md>): How Keyosk names users and keys in LiteLLM, and running several Keyosk instances on one gateway

## Optional

- [Development](<https://virtuos.github.io/keyosk/development/index.md>): Working on Keyosk itself: the dev stack and the tests