A web interface for monitoring and managing your LANCache. Track downloads, see which games are being cached, check bandwidth savings, and customize everything with themes.
Important
Always use the latest tag:
docker pull ghcr.io/regix1/lancache-manager:latestGitHub's package page shows :dev in the installation command because dev builds are pushed more frequently. :dev is unstable.
Use :latest for production. Use :dev only for testing.
Click the ⬆ arrow on any section to return here
- Screenshots
- Features
- Quick Start
- Getting Started
- Admin Features
- Custom Themes
- Optimization Settings
- Image Caching
- Nginx Log Rotation
- Depot Mappings
- Grafana & Prometheus Integration
- API Examples
- Troubleshooting
- Building from Source
- Contributing
- Support
- License
Screenshots ⬆
Stats at a glance - drag and drop to reorder cards, filter by time range
Normal View
Compact View
Switch between normal and compact views, filter and sort however you want
See which devices are using your cache
Manage sessions and control access
Authentication & Access
Integration & Services
Database Management
Import Historical Data
Disk Cache Management and Log Processing
Depot Mapping
Log & Cache Management
Game Cache Detection
Theme Management
Manage cache, process logs, configure depot mappings, and tweak settings
Sage and Wood
LANCache Unofficial
Features ⬆
- Draggable stat cards - Reorder them how you want, hide the ones you don't care about
- Time range filtering - Live, last hour, 24h, 7 days, 30 days, or custom date ranges
- Service breakdown - See which services (Steam, Epic, etc.) are eating your bandwidth
- Recent downloads - Quick view of what's been cached lately
- Top clients - See who's downloading the most
- Normal and Compact views - Cards or list, your choice
- Sorting - By date, size, cache efficiency, number of sessions, alphabetical
- Filtering - By service, client, hide small files, hide unknown games
- Presets - Pretty, Minimal, Show All, or tweak every setting yourself
- Export - JSON or CSV
- Cache operations - Clear cache, remove specific games or services
- Log processing - Reprocess logs, remove corruption
- Game detection - See what games are in your cache with actual sizes
- Database management - Clear specific tables without nuking everything
- Steam integration - PICS authentication for depot mappings
- Custom themes - Build your own or grab community themes
- Prometheus metrics - Export to Grafana
- Multi-device auth - Share API key across devices (configurable limit)
- Guest mode - Read-only access without API key
- Read-only volume support - Works fine with
:romounts
Quick Start ⬆
docker run -d \
--name lancache-manager \
-p 8080:80 \
-v ./data:/data \
-v /path/to/lancache/logs:/logs:ro \
-v /path/to/lancache/cache:/cache:ro \
-e TZ=America/Chicago \
-e LanCache__LogPath=/logs/access.log \
-e LanCache__CachePath=/cache \
ghcr.io/regix1/lancache-manager:latestversion: '3.8'
services:
lancache-manager:
image: ghcr.io/regix1/lancache-manager:latest
container_name: lancache-manager
restart: unless-stopped
ports:
- "8080:80"
volumes:
# Data directory - stores database, API key, themes, and cached images
- ./data:/data
# LANCache log directory (read-only recommended)
- /mnt/logs:/logs:ro
# LANCache cache directory
# Use :ro for read-only monitoring
# Remove :ro to enable cache clearing, corruption removal, and game removal
- /mnt/cache/cache:/cache:ro
# Docker socket for nginx log rotation (optional)
# Allows signaling nginx to reopen logs after manipulation
# Set NginxLogRotation__Enabled=false and remove this line to disable
- /var/run/docker.sock:/var/run/docker.sock:ro
environment:
#=== User/Group Settings ===#
# PUID/PGID: User and group ID the application runs as after setup
# Set these to match your NFS/host filesystem permissions
- PUID=1000
- PGID=1000
# TZ: Timezone for log timestamps and display
- TZ=America/Chicago
# ASPNETCORE_URLS: Internal port binding (required, do not change)
- ASPNETCORE_URLS=http://+:80
#=== Path Settings ===#
# LanCache__LogPath: Path to the LANCache access log file
- LanCache__LogPath=/logs/access.log
# LanCache__CachePath: Path to the LANCache cache directory
- LanCache__CachePath=/cache
#=== Security Settings ===#
# Security__EnableAuthentication: Master switch for authentication
# true = require API key for admin features (recommended)
# false = disable ALL authentication (dev/testing only)
- Security__EnableAuthentication=true
# Security__MaxAdminDevices: Number of devices that can use the same API key
- Security__MaxAdminDevices=3
# Security__GuestSessionDurationHours: Initial default for guest session duration
# Only used on first startup - can be changed in Management UI afterwards
# - Security__GuestSessionDurationHours=6
# Security__RequireAuthForMetrics: Require API key for /metrics endpoint
# true = Prometheus/Grafana must use Bearer token authentication
# false = /metrics endpoint is publicly accessible
- Security__RequireAuthForMetrics=false
#=== Nginx Log Rotation Settings ===#
# NginxLogRotation__Enabled: Auto-signal nginx to reopen logs after manipulation
# Prevents monolithic container from losing log file handle
# Requires docker.sock volume mount
- NginxLogRotation__Enabled=true
# NginxLogRotation__ContainerName: Name of the LANCache container
# Leave empty for auto-detection, or specify container name (e.g., "lancache")
- NginxLogRotation__ContainerName=
#=== Optimization Settings ===#
# Optimizations__EnableGarbageCollectionManagement: Enable GC controls in UI
# true = show memory management controls in Management page
# false = use default .NET garbage collection (recommended for most users)
# Enable this for low-memory systems or if memory usage climbs over time
- Optimizations__EnableGarbageCollectionManagement=false
#=== Cache Clearing Settings ===#
# CacheClear__DeleteMode: Default mode for cache clearing on startup
# Can be changed in Management UI during runtime (does not persist)
# "preserve" = keep directory structure, only delete files (default, safer)
# "full" = delete everything including directories (faster, more thorough)
# - CacheClear__DeleteMode=preserveGet your API key:
docker logs lancache-manager | grep "API Key"Also saved to /data/api_key.txt
Getting Started ⬆
- Start the container
- Get your API key from the logs or
/data/api_key.txt - Open
http://localhost:8080 - Go to Management and enter your API key
- Click "Process Logs" to start analyzing
If you mount with :ro, you'll see lock badges in Management. Totally fine for monitoring.
With read-only:
- View stats and downloads
- Monitor performance
- Track clients
To enable management features:
volumes:
- /path/to/cache:/cache # Can clear cache
- /path/to/logs:/logs:ro # Keep logs read-onlyAdmin Features ⬆
- Real-time sessions - See who's connected, what devices they're using
- Session types - Authenticated users get full access, guests get 6-hour read-only access
- Controls - Revoke sessions, delete records
- Auto-generated on first startup
- Saved to
/data/api_key.txt - Multi-device support (default 3 devices)
environment:
- Security__MaxAdminDevices=3Custom Themes ⬆
- Create themes from scratch with the visual editor
- Browse and install community themes
- Import/export as TOML files
- Auto-updates for installed themes
- Go to Management > Preferences > Theme Management
- Click Create Theme or edit existing
- Customize colors with live preview
- Save and apply
[meta]
name = "My Theme"
id = "my-theme"
isDark = true
version = "1.0.0"
author = "Your Name"
[colors]
primaryColor = "#3b82f6"
bgPrimary = "#111827"
textPrimary = "#ffffff"
# ... lots more optionsThemes save to /data/themes/
Optimization Settings ⬆
Optional GC controls for low-memory systems. Disabled by default.
environment:
- Optimizations__EnableGarbageCollectionManagement=trueOnce enabled, you get controls in Management:
- Collection aggressiveness
- Memory threshold
- Manual GC trigger
Use if: Low memory system, memory climbing over time
Skip if: 8GB+ RAM, performance matters more than memory
Image Caching ⬆
Game artwork gets cached automatically to /data/cached-img/. Loads instantly after first fetch, auto-updates when Steam changes artwork.
Clear cache:
docker stop lancache-manager
rm -rf ./data/cached-img
docker start lancache-managerNginx Log Rotation ⬆
LANCache's monolithic container has an nginx quirk - when you rotate logs, nginx keeps writing to the old file handle. This tool can signal nginx automatically.
volumes:
- /var/run/docker.sock:/var/run/docker.sock:ro
environment:
- NginxLogRotation__Enabled=true
- NginxLogRotation__ContainerName= # leave empty for auto-detectSecurity: Socket is read-only, only runs docker exec to send signals.
Manual alternative:
docker exec lancache nginx -s reopenDepot Mappings ⬆
Game identification uses mappings from lancache-pics - 290,000+ depot mappings, updated every 4 hours.
Download mappings:
- Go to Management > Depot Mappings
- Click Download from GitHub
- Wait 1-2 minutes
For private depots or unrecognized games, add custom mappings in the same section.
Steam provides two Web API versions for fetching game data:
| API Version | Requirements | Access Level |
|---|---|---|
| V2 | None | Public games only (no auth) |
| V2 + Account Login | Steam credentials | Public + playtest/restricted games |
| V1 | API Key | Public + playtest/restricted games |
Key difference: V1 API keys are tied to your Steam account, so they inherently provide access to playtest/restricted games without needing a separate login. V2 requires a Steam account login to access those same restricted games.
V1 API Key Setup:
- Get your API key from Steam Web API
- Go to Management > Steam Web API Status
- Click Configure API Key and enter your key
The system automatically uses V2 when available and falls back to V1 if V2 becomes unavailable.
| Method | Requirements | Access Level |
|---|---|---|
| Anonymous (V2) | None | Public games only |
| Account Login (V2) | V2 API + Steam credentials | Public + playtest/restricted games |
| V1 API Key | API key from Steam | Public + playtest/restricted games |
Important: Steam account login requires the V2 API to be available. When V2 is unavailable, the account login option is disabled. If you have a V1 API key configured, you already have access to playtest/restricted games through that key.
For most users: The V1 API key method is recommended. It provides access to all depot mappings including playtest games, doesn't require V2 API availability, and doesn't require entering your Steam password.
Grafana & Prometheus Integration ⬆
lancache_cache_capacity_bytes- Total storagelancache_cache_size_bytes- Used spacelancache_cache_hit_bytes_total- Bandwidth savedlancache_cache_miss_bytes_total- New data cachedlancache_active_downloads- Current downloadslancache_cache_hit_ratio- Effectiveness (0-1)lancache_downloads_by_service- Per-service breakdownlancache_bytes_served_by_service- Bandwidth per service
No auth:
scrape_configs:
- job_name: 'lancache-manager'
static_configs:
- targets: ['lancache-manager:80']
scrape_interval: 30s
metrics_path: /metricsWith auth:
environment:
- Security__RequireAuthForMetrics=truescrape_configs:
- job_name: 'lancache-manager'
static_configs:
- targets: ['lancache-manager:80']
scrape_interval: 30s
metrics_path: /metrics
authorization:
type: Bearer
credentials: 'your-api-key-here'# Cache hit rate
lancache_cache_hit_ratio * 100
# Bandwidth saved today
increase(lancache_cache_hit_bytes_total[24h])
# Cache usage in GB
lancache_cache_size_bytes / 1024 / 1024 / 1024
API Examples ⬆
Stats endpoints are public. Management endpoints need your API key.
# Dashboard stats
curl http://localhost:8080/api/stats/dashboard?period=24h
# Top games
curl http://localhost:8080/api/stats/top-games?limit=10
# Client stats
curl http://localhost:8080/api/stats/clients
# Process logs (needs API key)
curl -X POST -H "X-Api-Key: your-key" \
http://localhost:8080/api/management/process-all-logs
# Clear service cache (needs API key)
curl -X POST -H "X-Api-Key: your-key" \
http://localhost:8080/api/management/cache/clear/steam
# Prometheus metrics
curl http://localhost:8080/metricsTroubleshooting ⬆
- Check log path in Management > Settings
- Verify volume mount matches:
volumes: - /your/logs:/logs:ro # Must match LanCache__LogPath
- Click Process Logs in Management
- Check container logs:
docker logs lancache-manager
- Download latest mappings from Management > Depot Mappings > Download from GitHub
- Add custom mappings for private depots
- Click Reprocess All Logs after adding mappings
# Option 1: Check the file
cat ./data/api_key.txt
# Option 2: Check logs
docker logs lancache-manager | grep "API Key"
# Option 3: Generate new one
docker stop lancache-manager
rm ./data/api_key.txt
docker start lancache-manager
docker logs lancache-manager | grep "API Key"- Check volumes aren't read-only
- Verify PUID/PGID match file ownership:
ls -n /path/to/cache
- Update docker-compose:
environment: - PUID=1000 - PGID=1000
Building from Source ⬆
Requirements: .NET 8 SDK, Node.js 20+, Rust 1.75+
git clone https://github.com/regix1/lancache-manager.git
cd lancache-manager
# Rust processor
cd rust-processor
cargo build --release
# Web interface
cd ../Web
npm install
npm run dev # http://localhost:3000
# API
cd ../Api/LancacheManager
dotnet run # http://localhost:5000Docker build:
docker buildx build \
--platform linux/amd64,linux/arm64 \
-t ghcr.io/regix1/lancache-manager:latest \
--push \
.Contributing ⬆
Found a bug or have a feature request? Open an issue on GitHub.
Support ⬆
If this project has been helpful, consider supporting development.
Every coffee helps keep this project alive!
![@github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=64&v=4){kind=small}