Skip to content

LANCache Manager - Self-hosted web dashboard for monitoring Lancache data, Real-time download tracking, bandwidth analytics, cache management, and client monitoring. Docker deployment with Prometheus metrics and Grafana integration.

License

Notifications You must be signed in to change notification settings

regix1/lancache-manager

Repository files navigation

LANCache Manager

LANCache Manager is a simple web UI for monitoring and managing your LANCache. You can watch downloads in real time, see which games are cached, measure bandwidth savings, and prefill the cache before LAN parties.


Docker Installation

Important

Always use the latest tag:

docker pull ghcr.io/regix1/lancache-manager:latest

GitHub's package page shows :dev because dev builds are published more often. The :dev tag is for testing only and can be unstable.


Table of Contents


Screenshots

Dashboard

Dashboard Overview Dashboard Charts

Stats at a glance with draggable cards and time range filtering

Downloads

Normal View Downloads - Normal View

Compact View Downloads - Compact View

Retro View Downloads - Retro View

Three view modes to browse your cached games

Clients

Clients

Monitor which devices are using your cache

Users

Users - Session Overview Users - Details

Manage sessions and access controls

Events

Events Calendar

Calendar view of download activity and LAN events

Prefill

Steam Prefill

Pre-download games to your cache before your LAN party


Features

Dashboard

  • Draggable stat cards - Move or hide cards to match your layout
  • Time range filtering - Live, 1h, 24h, 7 days, 30 days, or custom
  • Service breakdown - Bandwidth usage per platform (Steam, Epic, Battle.net, and more)
  • Recent downloads - A quick view of what is being cached
  • Top clients - Find your heaviest users

Downloads

  • Three view modes - Normal (cards), Compact (list), and Retro (terminal style)
  • Flexible sorting - Date, size, cache efficiency, session count, or name
  • Powerful filtering - Filter by service, client, or hide small and unknown downloads
  • Data export - JSON or CSV

Clients

  • Device tracking - See every device that has used the cache
  • Client grouping - Add friendly names to keep things organized
  • Bandwidth stats - Usage breakdown per client

Users

  • Session management - View active authenticated and guest sessions
  • Guest access - Configurable read only access duration
  • Access control - Revoke sessions when needed

Events

  • Calendar view - Visualize download activity over time
  • Custom events - Create events for LAN parties
  • Activity tracking - See what was downloaded during each event

Prefill

  • Steam integration - Pre-download games directly to your cache
  • Steam Guard support - Works with all authentication methods
  • Library selection - Choose which games to prefill
  • Real-time progress - Monitor downloads as they happen

Management

  • Cache operations - Clear cache by service or remove specific games
  • Log processing - Reprocess logs and handle corruption
  • Game detection - See what games are in your cache with accurate sizes
  • Depot mappings - Download 290,000+ game mappings from GitHub
  • Theme editor - Create and import custom themes
  • Prometheus metrics - Export data to Grafana

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:latest

Getting Your API Key

docker logs lancache-manager | grep "API Key"

The key is also saved at /data/security/api_key.txt.

First Steps

  1. Open http://localhost:8080
  2. Go to Management and enter your API key
  3. Click Process Logs to analyze existing cache data

Docker Compose Reference

A complete docker-compose.yml with all available options:

version: '3.8'

services:
  lancache-manager:
    image: ghcr.io/regix1/lancache-manager:latest
    container_name: lancache-manager
    restart: unless-stopped
    ports:
      - "8080:80"
    volumes:
      # Required: Data directory for database, API key, themes, and cached images
      - ./data:/data

      # Required: LANCache log directory
      # Add :ro for read-only (recommended for monitoring-only setups)
      - /mnt/lancache/logs:/logs:ro

      # Required: LANCache cache directory
      # Add :ro for read-only monitoring
      # Remove :ro to enable cache clearing, corruption removal, and game removal
      - /mnt/lancache/cache:/cache:ro

      # Optional: Docker socket for nginx log rotation and Steam Prefill
      # Required for: signaling nginx to reopen logs, spawning prefill containers
      - /var/run/docker.sock:/var/run/docker.sock

    environment:
      #=========================================================================
      # REQUIRED - You must configure these for your environment
      #=========================================================================

      # User ID the application runs as (match your filesystem permissions)
      # Common values: 33 (www-data on Debian/Ubuntu), 1000 (default user)
      - PUID=33

      # Group ID the application runs as
      - PGID=33

      # Timezone for log timestamps and display
      # See: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
      - TZ=America/Chicago

      # Path to LANCache access log file (inside the container)
      - LanCache__LogPath=/logs/access.log

      # Path to LANCache cache directory (inside the container)
      - LanCache__CachePath=/cache

      # Path to lancache .env file (for reading CACHE_DISK_SIZE when Docker socket unavailable)
      # If not set, auto-searches: /srv/lancache/.env, /opt/lancache/.env, /lancache/.env
      # - LanCache__EnvFilePath=/lancache/.env

      #=========================================================================
      # OPTIONAL - Defaults work for most users (auto-detected or sensible defaults)
      #=========================================================================

      # Internal port binding (do not change unless you know what you're doing)
      - ASPNETCORE_URLS=http://+:80

      #---------------------------------------------------------------------------
      # Security Settings
      #---------------------------------------------------------------------------

      # Master switch for authentication
      # true = require API key for admin features (recommended)
      # false = disable ALL authentication (development only)
      # - Security__EnableAuthentication=true

      # Number of devices that can share the same API key simultaneously
      # - Security__MaxAdminDevices=3

      # Default guest session duration in hours (configurable in UI after first run)
      # - Security__GuestSessionDurationHours=6

      # Require API key for Prometheus /metrics endpoint
      # true = Prometheus must use Bearer token authentication
      # false = /metrics endpoint is publicly accessible
      # - Security__RequireAuthForMetrics=false

      # Require authentication to access Swagger API documentation
      # - Security__ProtectSwagger=true

      # Comma-separated list of allowed CORS origins (empty = allow all)
      # Example: http://localhost:3000,https://mysite.com
      # - Security__AllowedOrigins=

      # Allowed file browser root paths (comma-separated)
      # Example: /data,/mnt
      # - Security__AllowedBrowsePaths=

      #---------------------------------------------------------------------------
      # API Options
      #---------------------------------------------------------------------------

      # Max number of clients returned in a single stats request
      # - ApiOptions__MaxClientsPerRequest=1000

      # Default limit for clients when no limit is provided
      # - ApiOptions__DefaultClientsLimit=100

      #---------------------------------------------------------------------------
      # Nginx Log Rotation (auto-detects LANCache container)
      #---------------------------------------------------------------------------

      # Automatically signal nginx to reopen logs after manipulation
      # Prevents LANCache monolithic container from losing log file handle
      # Requires docker.sock volume mount
      # - NginxLogRotation__Enabled=true

      # Name of the LANCache container (auto for auto-detection)
      # Auto-detection finds containers with "lancache" in the name
      # - NginxLogRotation__ContainerName=auto

      # How often to check for log rotation needs (in hours)
      # - NginxLogRotation__ScheduleHours=24

      #---------------------------------------------------------------------------
      # Optimization Settings
      #---------------------------------------------------------------------------

      # Show memory management controls in Management page
      # Enable for low-memory systems or if memory usage climbs over time
      # Most users should leave this disabled
      # - Optimizations__EnableGarbageCollectionManagement=false

      #---------------------------------------------------------------------------
      # Steam Prefill (auto-detects host paths from container mounts)
      # Pre-download games to your cache before LAN parties
      # Powered by: https://github.com/regix1/steam-prefill-daemon
      # (Fork of https://github.com/tpill90/steam-lancache-prefill)
      #---------------------------------------------------------------------------

      # Docker image for per-user prefill containers
      # - Prefill__DockerImage=ghcr.io/regix1/steam-prefill-daemon:latest

      # Session timeout in minutes (inactive sessions get cleaned up)
      # - Prefill__SessionTimeoutMinutes=120

      # Base path for daemon session data (commands/responses)
      # Must be inside /data for Docker sibling container access
      # - Prefill__DaemonBasePath=/data/prefill

      # Host path that maps to /data in this container (auto for auto-detection)
      # Auto-detected from container mounts. Only set if auto-detection fails.
      # Example: If docker-compose.yml is at /srv/lancache/docker-compose.yml
      # and you have ./data:/data, set this to /srv/lancache/data
      # - Prefill__HostDataPath=auto

      # Use TCP mode for prefill daemon communication
      # Options: true, false, or auto (auto = true on Windows, false on Linux)
      # - Prefill__UseTcp=auto

      # TCP port inside the prefill container
      # - Prefill__TcpPort=4379

      # TCP port exposed on the host for prefill containers
      # - Prefill__HostTcpPort=4379

      # TCP host used by the prefill daemon
      # - Prefill__TcpHost=127.0.0.1


      # Network configuration for prefill containers (AUTO-DETECTED)
      # The app auto-detects your lancache-dns setup:
      #   - If lancache-dns uses host networking -> prefill uses host networking
      #   - If lancache-dns uses bridge -> prefill uses its IP for DNS
      # Only set these if auto-detection fails or you have a custom setup.

      # Network mode for prefill containers
      # Options: "host", "bridge", a custom Docker network name, or "auto"
      # - Prefill__NetworkMode=auto

      # Explicit lancache-dns IP (auto for auto-detection)
      # Find with: docker inspect lancache-dns | grep IPAddress
      # - Prefill__LancacheDnsIp=auto

      #=========================================================================
      # ADVANCED - Multiple Datasources (Optional)
      # Configure multiple LANCache instances or outsourced services
      # When DataSources are configured, LogPath/CachePath above are ignored
      #=========================================================================

      # Example: Main LANCache + outsourced Steam on separate drive
      #
      # - LanCache__DataSources__0__Name=Default
      # - LanCache__DataSources__0__CachePath=/cache
      # - LanCache__DataSources__0__LogPath=/logs
      # - LanCache__DataSources__0__Enabled=true
      #
      # - LanCache__DataSources__1__Name=Steam
      # - LanCache__DataSources__1__CachePath=/steam-cache
      # - LanCache__DataSources__1__LogPath=/steam-logs
      # - LanCache__DataSources__1__Enabled=true
      #
      # With additional volume mounts:
      # - /mnt/steam-drive/cache:/steam-cache:ro
      # - /mnt/steam-drive/logs:/steam-logs:ro

      # Auto-detect datasources by scanning for matching subdirectories
      # Scans /cache and /logs for folders that exist in both locations
      # Example: /cache/steam + /logs/steam -> creates "Steam" datasource
      # - LanCache__AutoDiscoverDatasources=true

      #=========================================================================
      # DEBUGGING - Enable verbose logging for troubleshooting
      #=========================================================================

      # Enable debug logging for platform-specific operations
      # - Logging__LogLevel__LancacheManager.Infrastructure.Platform=Debug

Note

Remove :ro from the cache volume if you want cache clearing and game removal. The Docker socket is optional but required for nginx log rotation and Steam Prefill.


Configuration Options

Volumes

Volume Purpose Notes
/data Database, security, state/config, themes, cached images Required
/logs LANCache access logs Add :ro for read-only
/cache LANCache cached files Add :ro for monitoring only
/var/run/docker.sock Docker API access Optional. Required for nginx rotation and Steam Prefill

User/Group Settings

Variable Default Description
PUID 33 User ID the app runs as. Match your filesystem permissions.
PGID 33 Group ID the app runs as.
TZ UTC Timezone for log timestamps (e.g., America/Chicago).

Path Settings

Variable Default Description
LanCache__LogPath - Path to the LANCache access log file.
LanCache__CachePath - Path to the LANCache cache directory.
LanCache__EnvFilePath (auto) Path to lancache .env file for reading CACHE_DISK_SIZE. Auto-searches common paths if not set.
LanCache__AutoDiscoverDatasources false Auto-detect datasources from matching subdirectories.

Security

Variable Default Description
Security__EnableAuthentication true Require API key for admin features. Set false for dev only.
Security__MaxAdminDevices 3 Number of devices that can share the same API key.
Security__GuestSessionDurationHours 6 Default guest session length (configurable in UI).
Security__RequireAuthForMetrics false Require API key for /metrics endpoint.
Security__ProtectSwagger true Require auth for Swagger API docs in production.
Security__AllowedOrigins (empty) Comma-separated CORS allow list. Empty allows all.
Security__AllowedBrowsePaths (empty) Comma-separated list of allowed file browser roots.

Access Levels

The API has two protection levels:

Level Description Examples
Admin Only Requires API key authentication Cache clearing, log processing, settings changes
Guest Session Requires admin auth or a valid guest session Viewing downloads, stats, events, client data

Guest sessions allow read-only access without sharing your API key. Guests must have a valid session created by an admin. No endpoints are public without authentication.

To grant guest access:

  1. Go to the Users tab
  2. Click Create Guest Link
  3. Share the link with your guests

Guests can view dashboards, downloads, and events but cannot modify settings or clear cache.

Nginx Log Rotation

Variable Default Description
NginxLogRotation__Enabled true Signal nginx to reopen logs after manipulation.
NginxLogRotation__ContainerName auto LANCache container name (auto for auto-detection).
NginxLogRotation__ScheduleHours 24 How often to check for rotation needs.

Optimization

Variable Default Description
Optimizations__EnableGarbageCollectionManagement false Enable memory management controls. Useful for low-memory systems.

Cache Clearing

Variable Default Description

API Options

Variable Default Description
ApiOptions__MaxClientsPerRequest 1000 Max clients returned in a single stats request.
ApiOptions__DefaultClientsLimit 100 Default client limit when none is provided.

Steam Prefill

Variable Default Description
Prefill__DockerImage ghcr.io/regix1/steam-prefill-daemon:latest Docker image for prefill containers.
Prefill__SessionTimeoutMinutes 120 Inactive session cleanup timeout.
Prefill__DaemonBasePath /data/prefill Session data storage path.
Prefill__HostDataPath auto Host path mapping to /data (auto for auto-detection).
Prefill__LancacheDnsIp auto IP of your lancache-dns container (auto for auto-detection).
Prefill__NetworkMode auto Network mode for prefill containers: host, bridge, a network name, or auto.
Prefill__UseTcp auto Use TCP for daemon communication (true, false, or auto). Auto defaults to true on Windows and false on Linux.
Prefill__TcpPort 4379 TCP port inside the prefill container.
Prefill__HostTcpPort 4379 TCP port exposed on the host for prefill containers.
Prefill__TcpHost 127.0.0.1 TCP host used by the prefill daemon.

Tabs Overview

Dashboard

Your home base for cache statistics. See overall performance, recent activity, and service breakdowns. Stat cards are draggable so you can arrange them your way.

Downloads

Browse everything that has been cached. Choose Normal view (cards with game art), Compact view (dense list for scanning), or Retro view (terminal look). Filter and sort to find what you want.

Clients

Track every device that has downloaded through your cache. Group clients with friendly names so it is easy to identify machines at a LAN party.

Users

Manage active sessions, create guest access links, configure session duration, and revoke sessions when needed. Guest sessions provide read-only access to dashboards, downloads, and events without sharing your API key.

Events

A calendar view of download activity over time. Create custom events for LAN parties and review what was downloaded during each one.

Prefill

Pre-download games to your cache before people arrive. Log in with Steam, pick games from your library, and let them run overnight.

Management

The admin panel (requires authentication). Process logs, clear cache, download depot mappings, configure Steam API access, manage themes, and handle database operations.


Steam Prefill

The Prefill tab helps you download games to your cache before your LAN party starts. It is powered by steam-prefill-daemon, a fork of steam-lancache-prefill by @tpill90.

Requirements

  • Docker socket mounted
  • Authenticated as admin
  • Lancache-dns container running, or manual DNS configuration

Network Configuration

For prefill to work, the prefill container needs:

  1. Internet access - to authenticate with Steam and download game data
  2. DNS resolution - Steam CDN domains should resolve to your cache server

The app auto-detects network settings in most cases:

  • If your lancache-dns uses network_mode: host, prefill containers also use host networking
  • Otherwise, it uses the lancache-dns container IP address for DNS resolution

Network Diagnostics: When a prefill session starts, the app tests the container network and logs the results. Check your container logs for output like:

═══════════════════════════════════════════════════════════════════════
  PREFILL CONTAINER NETWORK DIAGNOSTICS - prefill-daemon-abc123
═══════════════════════════════════════════════════════════════════════
  ✓ Internet connectivity: OK (reached api.steampowered.com)
  lancache.steamcontent.com resolved to 192.168.1.5
  ✓ DNS looks correct (private IP - likely your lancache server)
═══════════════════════════════════════════════════════════════════════

Manual configuration (if auto-detection fails):

environment:
  # Option 1: Use bridge networking (recommended for most setups)
  - Prefill__NetworkMode=bridge

  # Option 2: Use host networking (for host-networked lancache-dns)
  - Prefill__NetworkMode=host

  # Option 3: Explicit DNS IP (when lancache-dns IP is not auto-detected)
  - Prefill__LancacheDnsIp=192.168.1.10

Tip

If prefill containers have no internet access, try Prefill__NetworkMode=bridge. This is a common fix when Docker's default network isolation blocks outbound connections.

How It Works

  1. Go to the Prefill tab
  2. Log in with your Steam account (Steam Guard supported)
  3. Select games from your library
  4. Start the prefill

Downloads run in a separate container with real-time progress updates. When your guests arrive, the games are already cached and ready to serve at full speed.

Importing App IDs

If you are migrating from steam-lancache-prefill or you already have a list of Steam App IDs, you can import them directly:

  1. Click Select Apps to open the game selection modal
  2. Click Import App IDs to expand the import section
  3. Paste your App IDs in any of these formats:
    • Comma-separated: 730, 570, 440
    • JSON array: [730, 570, 440]
    • One per line
  4. Click Import

The import tells you how many games were added, how many were already selected, and how many IDs are not in your Steam library (these are skipped during prefill).

Migrating from steam-lancache-prefill: Copy the contents of your selectedAppsToPrefill.json file and paste it directly into the import field.


Custom Themes

Theme Editor

Go to Management > Preferences > Theme Management to:

  • Create themes from scratch with live preview
  • Browse and install community themes
  • Import and export themes as TOML files

Theme Format

[meta]
name = "My Theme"
id = "my-theme"
isDark = true
version = "1.0.0"
author = "Your Name"

[colors]
primaryColor = "#3b82f6"
bgPrimary = "#111827"
textPrimary = "#ffffff"

Themes are stored in /data/themes/.


Grafana & Prometheus

Available Metrics

Metric Description
lancache_cache_capacity_bytes Total storage capacity
lancache_cache_size_bytes Currently used space
lancache_cache_hit_bytes_total Bandwidth saved (cache hits)
lancache_cache_miss_bytes_total New data downloaded
lancache_active_downloads Current active downloads
lancache_cache_hit_ratio Cache effectiveness (0-1)
lancache_downloads_by_service Downloads per service
lancache_bytes_served_by_service Bandwidth per service

Prometheus Configuration

scrape_configs:
  - job_name: 'lancache-manager'
    static_configs:
      - targets: ['lancache-manager:80']
    scrape_interval: 30s
    metrics_path: /metrics

For authenticated metrics, set Security__RequireAuthForMetrics=true and add:

    authorization:
      type: Bearer
      credentials: 'your-api-key-here'

Example Queries

# Cache hit rate as percentage
lancache_cache_hit_ratio * 100

# Bandwidth saved in last 24 hours
increase(lancache_cache_hit_bytes_total[24h])

# Cache size in GB
lancache_cache_size_bytes / 1024 / 1024 / 1024

Multiple Datasources

Most users run a single LANCache instance and never touch this. If you have outsourced specific services to separate cache directories or you run multiple LANCache instances, you can configure multiple datasources and view them together in one dashboard.

When You Need This

  • Outsourced services - LANCache stores Steam on a separate drive from other services
  • Multiple LANCache instances - Separate cache servers for different purposes
  • Segmented storage - Different services on different drives or partitions

How It Works

Each datasource represents a log and cache directory pair. The app processes logs and tracks cache usage separately for each one, then combines the results in the dashboard and downloads views.


Auto-Discovery (Recommended)

The easiest approach is to let the app scan for matching subdirectories:

environment:
  - LanCache__LogPath=/logs
  - LanCache__CachePath=/cache
  - LanCache__AutoDiscoverDatasources=true

What it detects:

  1. Root-level datasource - If /logs/access.log exists and /cache contains LANCache hash directories (00/, 01/, and so on), it creates a "Default" datasource
  2. Subdirectory datasources - For each folder that exists in both /cache and /logs, it creates a named datasource (e.g., /cache/steam + /logs/steam -> "Steam")

Example directory structure:

/mnt/lancache/
├── cache/
│   ├── 00/, 01/, a1/, ff/    ← Default cache (hash dirs at root)
│   ├── steam/
│   │   └── 00/, 01/, ...     ← Outsourced Steam
│   └── epic/
│       └── 00/, 01/, ...     ← Outsourced Epic
└── logs/
    ├── access.log            ← Default log
    ├── steam/
    │   └── access.log        ← Steam log
    └── epic/
        └── access.log        ← Epic log

This creates three datasources: Default, Steam, and Epic.

Note

Folder matching is case-insensitive. Steam, steam, and STEAM all match.


Manual Configuration

For precise control or when directories are on separate drives, define each datasource explicitly:

environment:
  # Main LANCache
  - LanCache__DataSources__0__Name=Default
  - LanCache__DataSources__0__CachePath=/cache
  - LanCache__DataSources__0__LogPath=/logs
  - LanCache__DataSources__0__Enabled=true

  # Steam on a separate drive
  - LanCache__DataSources__1__Name=Steam
  - LanCache__DataSources__1__CachePath=/steam-cache
  - LanCache__DataSources__1__LogPath=/steam-logs
  - LanCache__DataSources__1__Enabled=true

With corresponding volume mounts:

volumes:
  - /mnt/lancache/cache:/cache:ro
  - /mnt/lancache/logs:/logs:ro
  - /mnt/steam-drive/cache:/steam-cache:ro
  - /mnt/steam-drive/logs:/steam-logs:ro

Note

Manual datasource configuration takes priority over auto-discovery.


Nginx Reverse Proxy

LANCache Manager works well behind Nginx. HTTPS is recommended and required for guest session cookies on cross-origin image requests.

Single origin (recommended)

Serve the UI and API from the same origin. This keeps cookies first-party and avoids cross-origin issues.

server {
  listen 443 ssl http2;
  server_name lancache.example.com;

  ssl_certificate     /etc/letsencrypt/live/lancache.example.com/fullchain.pem;
  ssl_certificate_key /etc/letsencrypt/live/lancache.example.com/privkey.pem;

  # Increase if you have large responses
  client_max_body_size 50m;

  location / {
    proxy_pass http://127.0.0.1:8080;
    proxy_http_version 1.1;
    proxy_set_header Host $host;
    proxy_set_header X-Real-IP $remote_addr;
    proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
    proxy_set_header X-Forwarded-Proto $scheme;
    proxy_set_header X-Forwarded-Host $host;

    # SignalR (WebSockets)
    proxy_set_header Upgrade $http_upgrade;
    proxy_set_header Connection "upgrade";
    proxy_read_timeout 600s;  # Must match SignalR timeout (10 min) to prevent nginx killing idle WebSocket connections
  }
}

server {
  listen 80;
  server_name lancache.example.com;
  return 301 https://$host$request_uri;
}

Separate API origin (only if required)

If you split UI and API across hosts, use HTTPS and allow credentials. In that case:

  • Set VITE_API_URL=https://api.lancache.example.com when building the Web UI.
  • Keep SameSite=None; Secure cookies (configured by the app).
  • Ensure CORS allows credentials for your UI origin.

Example API proxy:

server {
  listen 443 ssl http2;
  server_name api.lancache.example.com;

  ssl_certificate     /etc/letsencrypt/live/api.lancache.example.com/fullchain.pem;
  ssl_certificate_key /etc/letsencrypt/live/api.lancache.example.com/privkey.pem;

  location / {
    proxy_pass http://127.0.0.1:8080;
    proxy_http_version 1.1;
    proxy_set_header Host $host;
    proxy_set_header X-Real-IP $remote_addr;
    proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
    proxy_set_header X-Forwarded-Proto $scheme;
    proxy_set_header X-Forwarded-Host $host;

    # SignalR (WebSockets)
    proxy_set_header Upgrade $http_upgrade;
    proxy_set_header Connection "upgrade";
    proxy_read_timeout 600s;  # Must match SignalR timeout (10 min) to prevent nginx killing idle WebSocket connections
  }
}

Troubleshooting

Logs Not Processing

  1. Verify the log path in Management > Settings
  2. Confirm your volume mount matches LanCache__LogPath
  3. Click Process Logs in Management
  4. Check container logs: docker logs lancache-manager

Games Not Identified

  1. Download the latest mappings from Management > Depot Mappings
  2. Add custom mappings for private depots if needed
  3. Click Reprocess All Logs after adding mappings

Lost API Key

cat ./data/security/api_key.txt
# or
docker logs lancache-manager | grep "API Key"

To generate a new key, stop the container, delete ./data/security/api_key.txt, and restart.

Permission Issues

Verify PUID and PGID match your file ownership:

ls -n /path/to/cache

Prefill Not Working

  1. Ensure the Docker socket is mounted
  2. Confirm you are authenticated as admin
  3. Check container logs for network diagnostics output (look for ═══ PREFILL CONTAINER NETWORK DIAGNOSTICS ═══)
  4. Container has no internet access: The prefill container cannot reach Steam. Common fixes:
    • Set Prefill__NetworkMode=bridge in your docker-compose.yml (recommended for most setups)
    • Ensure your Docker network has outbound internet access
    • Check firewall rules for outbound connections
  5. HTTP 400 errors during download: The prefill container cannot resolve Steam CDN domains to your cache. Try one of the following:
    • Set Prefill__NetworkMode=host if your lancache-dns uses host networking
    • Set Prefill__LancacheDnsIp to your lancache-dns IP address
    • The app auto-detects this if your lancache-dns container is running
  6. DNS bypassing lancache via IPv6: If your network uses IPv6, DNS queries might bypass lancache-dns. The app automatically disables IPv6 in prefill containers to prevent this.

Network Diagnostics: When a prefill container starts, the app runs network diagnostics that appear in the logs:

  • Internet connectivity test (can reach api.steampowered.com)
  • DNS resolution for lancache.steamcontent.com and steam.cache.lancache.net
  • Warnings if DNS resolves to public IPs instead of your cache

Finding your lancache-dns IP:

docker inspect lancache-dns | grep IPAddress

Example configurations:

Bridge mode (recommended for most Docker setups):

environment:
  - Prefill__NetworkMode=bridge

Host networking (when lancache-dns uses host mode):

environment:
  - Prefill__NetworkMode=host

Explicit DNS IP (when auto-detection fails):

environment:
  - Prefill__LancacheDnsIp=192.168.1.10

Debug Logging

If you're experiencing issues with path resolution, file system detection, Docker communication, or other platform-specific operations, you can enable verbose debug logging:

environment:
  - Logging__LogLevel__LancacheManager.Infrastructure.Platform=Debug

What it logs:

  • Path resolution and validation (container vs host paths)
  • File system operations and permission checks
  • Docker socket communication and container detection
  • Volume mount detection and mapping
  • Platform-specific behavior (Linux vs Windows differences)

How to use:

  1. Add the environment variable to your docker-compose.yml
  2. Restart the container: docker compose up -d
  3. Reproduce the issue
  4. View logs: docker logs lancache-manager
  5. Remove the variable when done (debug logging is verbose)

This is especially helpful when:

  • Auto-detection of paths or Docker settings fails
  • Prefill containers aren't spawning correctly
  • Volume mounts don't seem to be recognized
  • You're running on an unusual platform or Docker setup

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:5000

Docker build:

docker buildx build \
  --platform linux/amd64,linux/arm64 \
  -t ghcr.io/regix1/lancache-manager:latest \
  --push .

Contributing Translations

LANCache Manager supports internationalization (i18n) and welcomes community translations. The app is ready for localization and all UI strings are already externalized.

How to Contribute

  1. Fork the repository on GitHub
  2. Navigate to Web/src/i18n/locales/
  3. Copy en.json to a new file named with your language code (e.g., de.json, fr.json, es.json, pt-BR.json)
  4. Translate all the string values (keep the keys unchanged)
  5. Submit a Pull Request with your translation

Translation File Structure

Web/src/i18n/locales/
├── en.json          ← English (reference)
├── de.json          ← German (your contribution)
├── fr.json          ← French (your contribution)
└── ...

Guidelines

  • Keep JSON keys unchanged - Only translate the string values
  • Preserve placeholders - Keep {{variable}} placeholders intact (e.g., {{name}})
  • Maintain formatting - Preserve any HTML tags like <strong> if present
  • Test your translation - Run the app locally to verify your translations display correctly

Example

// en.json
{
  "dashboard": {
    "title": "Dashboard",
    "recentDownloads": "Recent Downloads",
    "totalCache": "Total Cache: {{size}}"
  }
}

// de.json
{
  "dashboard": {
    "title": "Übersicht",
    "recentDownloads": "Letzte Downloads",
    "totalCache": "Gesamter Cache: {{size}}"
  }
}

Need Help?

If you run into issues, feel free to open an issue on GitHub.

You can also find the LANCache community at the LanCache.NET Discord.


Support

Enjoying LANCache Manager?

If this project has been helpful, consider supporting development.


Buy Me A Coffee

☕ Click to donate


Every coffee helps keep this project alive!


License

MIT License

About

LANCache Manager - Self-hosted web dashboard for monitoring Lancache data, Real-time download tracking, bandwidth analytics, cache management, and client monitoring. Docker deployment with Prometheus metrics and Grafana integration.

Topics

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors 2

  •  
  •