onyx_online/q3rcon-proxy
1
0
Fork 0
mirror of https://github.com/onyx-and-iris/q3rcon-proxy.git synced 2025-01-18 08:40:53 +00:00
Code Issues Packages Projects Releases Wiki Activity

readme initial commit

Browse Source
This commit is contained in:
onyx-and-iris 2024-01-27 14:49:08 +00:00
parent 3f35d9ffc5
commit fd4f873c9c
1 changed files with 28 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
README.md Normal file
View File

@ -0,0 +1,28 @@
# Q3 Rcon Proxy
A modification of [lilproxy][lilproxy_url] that forwards only Q3 rcon/query packets. Useful for separating the rcon port from the game server port.
### Use
Run one or multiple rcon proxies by setting an environment variable `Q3RCON_PROXY`
for example:
```bash
export Q3RCON_PROXY="20000:28960;20001:28961;20002:28962"
```
This would run 3 proxy servers listening on ports `20000`, `20001` and `20002` that redirect rcon requests to game servers on ports `28960`, `28961` and `28962` respectively.
### Why
Avoid sending plaintext rcon requests (that include the password) to public ports. Instead send them to whitelisted ports.
Gives you the option to disable remote rcon entirely and have the server accept requests only from localhost.
### Special Thanks
[Dylan][user_link] For writing this proxy.
[lilproxy_url]: https://github.com/dgparker/lilproxy
[user_link]: https://github.com/dgparker