English | 中文
A web UI for LANCache. See what your cache is doing, and act on it, without touching a terminal. Available in English and 简体中文.
The dashboard is the live view: bandwidth saved, cache hit ratio, top clients, and per-service analytics. Behind it sits a full cache browser with every cached game, its cover art, size, and per-client history. Prometheus metrics are exposed out of the box.
It also acts on the cache. Prefill Steam, Epic, Battle.net, Riot, and Xbox games before guests arrive, by hand or on a schedule, and run the server from the browser: process logs, clear cache, detect corruption, and check DNS and cache health when something looks off.
Important
Always pull the latest tag. GitHub's package page surfaces :dev because dev builds publish more often, but :dev is for testing only and can break at any time.
docker pull ghcr.io/regix1/lancache-manager:latestYou need a running LANCache whose logs and cache this host can read, and Docker with the Compose plugin. The default image bundles its own PostgreSQL, so this is the whole install:
services:
lancache-manager:
image: ghcr.io/regix1/lancache-manager:latest
container_name: lancache-manager
restart: unless-stopped
ports:
- "8080:80"
volumes:
- ./data:/data
- /mnt/lancache/logs:/logs:ro
- /mnt/lancache/cache:/cache:ro
- /var/run/docker.sock:/var/run/docker.sock # Optional: for prefill and log rotation
environment:
- PUID=33
- PGID=33
- TZ=America/Chicago
- LanCache__LogPath=/logs/access.log
- LanCache__CachePath=/cachedocker compose up -dThen open http://<host>:8080 and get your API key with docker exec lancache-manager cat /data/security/api_key.txt.
On first run you choose how people sign in: username and password, either of those behind the API key, single sign-on with Google, GitHub, Microsoft, Apple or OIDC, or no authentication at all on a trusted LAN. Upgrading installs confirm the choice once, and the primary administrator can change it later at Users → Accounts → Access and sign-in. The API key stays valid for ownership and recovery whichever mode you pick.
Setup details, provider requirements and how to recover from a locked-out SSO are in Sign-in and Access. The Quick Start guide has the full walkthrough, including the cache path gotcha that catches most people.
The full documentation lives at regix1.github.io/lancache-manager.
| Guide | What it covers |
|---|---|
| Quick Start | Install, first run, API key |
| Sign-in and Access | Choosing a sign-in mode, single sign-on, recovery |
| Upgrading | Moving up a version, what carries over |
| What You Get | A tour of every page in the app |
| Prefill | Steam, Epic, Battle.net, Riot, Xbox, and scheduling |
| Bare-Metal LANCache | Running against a non-Docker cache |
| Images and Database Modes | Embedded vs external PostgreSQL |
| Configuration Reference | Every environment variable and volume |
| Unraid / Recipes | Unraid Docker template setup |
| Multiple Datasources | Split caches or combine several LANCache servers |
| Reverse Proxy | Nginx in front of the manager |
| Prometheus Metrics | Scraping /metrics and example queries |
| API Reference | Every endpoint, plus a plain-text summary to hand an AI assistant |
| Troubleshooting | Logs not processing, games not identified, permissions |
| Custom Themes | Building and sharing a theme |
| Building from Source | Local development |
| Contributing Translations | Adding or improving a language |
Stuck on something? Open an issue, or find the LANCache community on the LanCache.NET Discord.
If LANCache Manager has been useful and you want to support development, you can buy me a coffee.
Licensed under the GNU Affero General Public License v3.0. Self-host it, modify it, and use it however you like. If you run a modified version for other people, including as a hosted service, you must offer those users the corresponding source of your modified version under the same license.
Versions up to and including 1.10.3 were released under MIT and stay MIT. The name and logo are covered by the Trademark Policy. Contributions are accepted under these terms. Full details on the Support and License page.