docs: update README with garbage collection details and Windows hosts file override instructions

This commit is contained in:
2025-01-21 15:23:24 -06:00
parent e27a64fb2e
commit 4caa14fa68

View File

@@ -6,6 +6,7 @@ SteamCache2 is a blazing fast download cache for Steam, designed to reduce bandw
- High-speed caching for Steam downloads
- Tiered storage for getting the most out of your storage media
- Garbage Collected storage for limiting the size of RAM or Disk cache and will not go above what you choose or stop caching unlike others
- Reduces bandwidth usage
- Easy to set up and configure aside from dns stuff to trick Steam into using it
- Supports multiple clients
@@ -14,9 +15,43 @@ SteamCache2 is a blazing fast download cache for Steam, designed to reduce bandw
1. Start the cache server:
```sh
./SteamCache2
./SteamCache2 --memory 1G --disk 10G --disk-path tmp/disk
```
2. Configure your Steam client to use the cache server as a proxy.
2. Configure your DNS:
- If your on Windows and don't want a whole network implementation (THIS)[#windows-hosts-file-override]
### Windows Hosts File Override
1. Open Notepad as Administrator:
- Click on the Start menu, type `Notepad`, right-click on Notepad, and select `Run as administrator`.
2. Open the Hosts File:
- In Notepad, go to `File` > `Open`.
- Navigate to `C:\Windows\System32\drivers\etc`.
- Select `All Files` from the dropdown menu to see the hosts file.
- Open the `hosts` file.
3. Add the Override Entry:
- At the end of the file, add a new line with the IP address of your SteamCache2 server followed by `lancache.steamcontent.com`. For example:
```plaintext
192.168.1.100 lancache.steamcontent.com
```
Replace `192.168.1.100` with the actual IP address of your SteamCache2 server.
4. Save the Hosts File:
- Save the changes by going to `File` > `Save`.
5. Flush DNS Cache (optional but recommended):
- Open Command Prompt as Administrator.
- Run the following command to flush the DNS cache:
```sh
ipconfig /flushdns
```
6. Restart
- Restart Steam or Restart Your PC
This will direct any requests to `lancache.steamcontent.com` to your SteamCache2 server.
## License
@@ -24,4 +59,4 @@ This project is licensed. See the [LICENSE](LICENSE) file for details.
## Acknowledgements
- Inspired by other caching solutions for game platforms.
- Inspired by [Lancache.net](https://lancache.net/)