upd dockerfile

expand readme

CHANGELOG.md

@@ -13,7 +13,7 @@ Before any major/minor/patch bump all unit tests will be run to verify they pass
 
 ## [0.1.0] - 2024-01-27
 
--   ignore any packets whose header does match a q3 rcon/query packet.
+-   only forward packets if the header matches q3 rcon/query.
 
 ## [0.0.1] - 2024-01-27
 

Dockerfile

@@ -1,12 +1,14 @@
-FROM golang:alpine
+FROM golang:1.21
 
-WORKDIR /dist
+WORKDIR /usr/src/app
 
-COPY . .
-
-# build binary and place into /usr/local/bin
+# pre-copy/cache go.mod for pre-downloading dependencies and only redownloading them in subsequent builds if they change
+COPY go.mod go.sum ./
 RUN go mod download && go mod verify
-RUN go build -v -o /usr/local/bin/q3rcon-proxy ./cmd/q3rcon-proxy
+
+# build binary and place into /usr/local/bin/
+COPY . .
+RUN go build -v -o /usr/local/bin/q3rcon-proxy ./cmd/q3rcon-proxy/
 
 # Command to run when starting the container
 ENTRYPOINT [ "q3rcon-proxy" ]

README.md

@@ -12,13 +12,13 @@ for example:
 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.
+This would configure q3rcon-proxy to 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.
+
+Then just run the binary which you can compile yourself, download from `Releases` or use the included Dockerfile.
 
 ### 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.
+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.
 
 ### Special Thanks
 

pkg/udpproxy/udpproxy_test.go

@@ -1,83 +0,0 @@
-package udpproxy
-
-import (
-	"log"
-	"net"
-	"testing"
-	"time"
-)
-
-func TestSendAndReceive(t *testing.T) {
-	go runLilProxy()
-	go runUDPServer()
-
-	paddr, err := net.ResolveUDPAddr("udp", "localhost:9000")
-	if err != nil {
-		t.Fatal(err)
-	}
-
-	conn, err := net.DialUDP("udp", nil, paddr)
-	if err != nil {
-		t.Fatal(err)
-	}
-
-	go func() {
-		for {
-			buf := make([]byte, 2048)
-			_, _, err = conn.ReadFromUDP(buf)
-			if err != nil {
-				log.Fatal(err)
-			}
-
-			log.Printf("response received: %s", string(buf))
-		}
-	}()
-
-	for {
-		time.Sleep(1 * time.Second)
-		_, err = conn.Write([]byte("hi\n"))
-		if err != nil {
-			log.Fatal(err)
-		}
-	}
-}
-
-func runLilProxy() {
-	port := ":9000"
-	target := "localhost:9001"
-
-	c, err := New(port, target)
-	if err != nil {
-		log.Fatal(err)
-	}
-
-	log.Fatal(c.ListenAndServe())
-}
-
-func runUDPServer() {
-	taddr, err := net.ResolveUDPAddr("udp", ":9001")
-	if err != nil {
-		log.Fatal(err)
-	}
-
-	conn, err := net.ListenUDP("udp", taddr)
-	if err != nil {
-		log.Fatal(err)
-	}
-
-	for {
-		buf := make([]byte, 2048)
-		_, caddr, err := conn.ReadFromUDP(buf)
-		if err != nil {
-			log.Fatal(err)
-		}
-
-		log.Printf("request received: %s", string(buf))
-
-		_, err = conn.WriteToUDP([]byte("bye\n"), caddr)
-		if err != nil {
-			log.Fatal(err)
-		}
-
-	}
-}