Skip to content

peerau/steamcache-generic

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

14 Commits
 
 
 
 
 
 
 
 

Repository files navigation

Game Download Cache Docker Container

Introduction

This docker container provides a caching proxy server for game download content. For any network with more than one PC gamer in connected this will drastically reduce internet bandwidth consumption.

The primary use case is gaming events, such as LAN parties, which need to be able to cope with hundreds or thousands of computers receiving an unannounced patch - without spending a fortune on internet connectivity. Other uses include smaller networks, such as Internet Cafes and home networks, where the new games are regularly installed on multiple computers; or multiple independent operating systems on the same computer.

This container is designed to support any game that uses HTTP and also supports HTTP range requests (used by Origin). This should make it suitable for:

  • Origin (EA Games)
  • Riot Games (League of Legends)
  • Battle.net (Hearthstone, Starcraft 2, Overwatch)
  • Frontier Launchpad (Elite Dangerous, Planet Coaster)
  • Uplay (Ubisoft)
  • Windows Updates

You can use this container for Steam, however our steamcache container is a better option as it uses a different caching method that's better for Steam.

Usage

You will need to have a DNS server forwarding queries to the machine your docker container is running on. You can use the steamcache-dns docker image to do this or you can use a DNS service already on your network see the steamcache-dns github page for more information.

Run the origin container using the following to allow TCP port 80 (HTTP) through the host machine:

docker run --name lancache -p 192.168.0.5:80:80 steamcache/generic:latest

Quick Explanation

For an game cache to function on your network you need two services.

The cache service transparently proxies your requests for content to the content procider, or serves the content to you if it already has it.

The special DNS service handles DNS queries normally (recursively), except when they're about the games you're interested in and in that case it responds that the depot cache service should be used.

Note: steamcache-dns does not currently support these providers. It will be updated soon.

DNS Entries

You will need to add DNS Zones for the following hostnames, pointing to the IP of the cache container:

Origin:

  • origin-a.akamaihd.net

Riot Games:

  • l3cdn.riotgames.com
  • worldwide.l3cdn.riotgames.com

Frontier Launchpad:

  • cdn.zaonce.net

Battle.net

  • dist.blizzard.com
  • llnw.blizzard.com
  • blzddist1-a.akamaihd.net
  • blzddist2-a.akamaihd.net
  • dist.blizzard.com.edgesuite.net

Windows Update

  • download.windowsupdate.com

Uplay

  • cdn.ubi.com

Suggested Hardware

Regular commodity hardware (a single 2TB WD Black on an HP Microserver) can achieve peak throughputs of 30MB/s+ using this setup (depending on the specific content being served).

Monitoring

Tail the access logs (default: /data/logs/access.log).

Running on Startup

Follow the instructions in the Docker documentation to run the container at startup. Documentation

Thanks

Based on original configs from ansible-lanparty.

License

The MIT License (MIT)

Copyright (c) 2016 Jessica Smith, Robin Lewis, Brian Wojtczak, Jason Rivers

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Releases

No releases published

Packages

No packages published

Languages

  • Nginx 89.7%
  • Shell 10.3%