params.json

{"name":"LanCache.Net","tagline":"","body":"# LanCache.Net\r\n\r\nLanCache.Net provides the ability to reduce your Internet bandwidth consumption in scenarios where you have multiple PC gamers sharing the same Internet connection. Through the use of easy to deploy docker containers we aim to make it easy for you to get a local cache of steam's content servers up and running quickly.\r\n\r\nThe 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 new games are regularly installed on multiple computers; or multiple independent operating systems on the same computer.\r\n\r\n## Prerequisites\r\n\r\n * Some local dedicated server hardware\r\n\r\n\tLots of RAM and a reasonably fast SSD or HDD is recommended. 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).\r\n\r\n * Linux with Docker\r\n\r\n \tWe suggest [Ubuntu server](http://www.ubuntu.com/server) because it is really easy, but any Linux is ok. Running on Windows or Mac OS X is not recommended for performance reasons. Please see the [Docker installation instructions](https://docs.docker.com/engine/installation/).\r\n\r\n## Usage\r\n\r\n1. Run the steamcache reverse proxy container\r\n\r\n\t```\r\n\tdocker run --name steamcache -p 80:80 lancachenet/steamcache\r\n\t```\r\n\r\n\tNote that this container requires the use of port 80 and so may not be run on the same machine as some other website. A dedicated caching server is recommended.\r\n\r\n2. Run the steamcache DNS server container\r\n\r\n\tWhen starting this container you need to pass in the IP address which the reverse proxy container is running on. Assuming that you're running both containers on the same machine then this will just be the IP address of that machine.  This command looks up that IP and then starts the container using it.\r\n\r\n\t```shell\r\n\texport STEAMCACHE_IP=`ip -4 addr show docker0 | grep -Po \"inet \\K[\\d.]+\"`;\r\n\tdocker run --name lancache-dns -p 53:53/udp -e STEAMCACHE_IP=$STEAMCACHE_IP lancachenet/lancache-dns\r\n\t```\r\n\r\n\tIf you want to specify  the IP then just place it in the run command like\r\n\r\n\t```shell\r\n\tdocker run --name lancache-dns -p 53:53/udp -e STEAMCACHE_IP=111.111.111.111 lancachenet/lancache-dns\r\n\t```\r\n\r\n\tNow anyone using this DNS server will have their steam traffic severed by the cache.\r\n\r\n3. Change your DHCP server to give out the IP address of the steamcache DNS container as primary DNS\r\n\r\nNow, as people join your network they will automatically be configured to use the steam cache (unless they've chosen to override DNS on their local PC).\r\n\r\n## Running on Startup\r\n\r\nPlease follow the [instructions in the Docker documentation](https://docs.docker.com/articles/host_integration/) to run the container at startup.\r\n","google":"","note":"Don't delete this file! It's used internally to help with page regeneration."}