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

add Logging section to README.

Browse Source
This commit is contained in:
onyx-and-iris 2024-09-28 15:37:38 +01:00
parent 3d1c8f90f3
commit 51f22f480b
2 changed files with 12 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
.gitignore vendored
View File

@ -19,3 +19,7 @@
# Go workspace file # Go workspace file
go.work go.work
# testing
run.sh
server.yaml

10
README.md
View File

@ -2,6 +2,10 @@
A modification of [lilproxy][lilproxy_url] that forwards only Q3 rcon/query packets. Useful for separating the rcon port from the game server port. A modification of [lilproxy][lilproxy_url] that forwards only Q3 rcon/query packets. Useful for separating the rcon port from the game server port.
### Why
Unfortunately the Q3Rcon engine ties the rcon port to the game servers public port used for client connections. This proxy will allow you to run rcon through a separate whitelisted port.
### Use ### Use
Run one or multiple rcon proxies by setting an environment variable `Q3RCON_PROXY` Run one or multiple rcon proxies by setting an environment variable `Q3RCON_PROXY`
@ -16,9 +20,11 @@ This would configure q3rcon-proxy to run 3 proxy servers listening on ports `200
Then just run the binary which you can compile yourself, download from `Releases` or use the included Dockerfile. Then just run the binary which you can compile yourself, download from `Releases` or use the included Dockerfile.
### Why ### Logging
Avoid sending plaintext rcon commands to the public game server port. In general I would advise anyone using rcon remotely to use a secured connection but perhaps you've passed rcon to a clan friend who doesn't know about secured connections. Now you can instruct them to use rcon only through a whitelisted port. Set the log level with environment variable `Q3RCON_LOGLEVEL`:
`0 = Panic, 1 = Fatal, 2 = Error, 3 = Warning, 4 = Info, 5 = Debug, 6 = Trace`
### Special Thanks ### Special Thanks