.dockerignore

@@ -1,6 +0,0 @@
-*
-!cmd/
-!pkg/
-
-!go.mod
-!go.sum

.github/workflows/release.yml

@@ -1,31 +0,0 @@
-name: goreleaser
-
-on:
-  push:
-    tags:
-      - 'v*' # Push events to matching v*, i.e. v1.0, v20.15.10
-
-permissions:
-  contents: write
-
-jobs:
-  goreleaser:
-    runs-on: ubuntu-latest
-    steps:
-      -
-        name: Checkout
-        uses: actions/checkout@v4
-        with:
-          fetch-depth: 0
-      -
-        name: Set up Go
-        uses: actions/setup-go@v5
-      -
-        name: Run GoReleaser
-        uses: goreleaser/goreleaser-action@v6
-        with:
-          distribution: goreleaser
-          version: '~> v2'
-          args: release --clean
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/update-go-modules.yml

@@ -1,30 +0,0 @@
-name: Auto-Update Go Modules
-
-on:
-  schedule:
-    - cron: "0 0 * * 1" # Runs every Monday at midnight
-
-jobs:
-  update-go-modules:
-    runs-on: ubuntu-latest
-    permissions:
-      contents: write
-
-    steps:
-      - name: Checkout Code
-        uses: actions/checkout@v4
-
-      - name: Set up Go
-        uses: actions/setup-go@v5
-        with:
-          go-version: stable
-
-      - name: Update Dependencies
-        run: |
-          go get -u ./...
-          go mod tidy
-          git config user.name "github-actions[bot]"
-          git config user.email "github-actions[bot]@users.noreply.github.com"
-          git add go.mod go.sum
-          git commit -m "chore: auto-update Go modules"
-          git push

.gitignore

@@ -1,5 +1,3 @@
-# Auto-generated .gitignore by gignore: github.com/onyx-and-iris/gignore
-### Go ###
 # If you prefer the allow list template instead of the deny list, see community template:
 # https://github.com/github/gitignore/blob/main/community/Golang/Go.AllowList.gitignore
 #
@@ -9,7 +7,6 @@
 *.dll
 *.so
 *.dylib
-bin/
 
 # Test binary, built with `go test -c`
 *.test
@@ -22,7 +19,7 @@ bin/
 
 # Go workspace file
 go.work
-# End of gignore: github.com/onyx-and-iris/gignore
 
-# Added by goreleaser init:
-dist/
+# testing
+run.sh
+server.yaml

.goreleaser.yaml

@@ -1,55 +0,0 @@
-# This is an example .goreleaser.yml file with some sensible defaults.
-# Make sure to check the documentation at https://goreleaser.com
-
-# The lines below are called `modelines`. See `:help modeline`
-# Feel free to remove those if you don't want/need to use them.
-# yaml-language-server: $schema=https://goreleaser.com/static/schema.json
-# vim: set ts=2 sw=2 tw=0 fo=cnqoj
-
-version: 2
-
-before:
-  hooks:
-    # You may remove this if you don't use go modules.
-    - go mod tidy
-    # you may remove this if you don't need go generate
-    - go generate ./...
-
-builds:
-  - main: ./cmd/q3rcon-proxy/
-    env:
-      - CGO_ENABLED=0
-    goos:
-      - linux
-      - windows
-    goarch:
-      - amd64
-
-archives:
-  - formats: ['tar.gz']
-    # this name template makes the OS and Arch compatible with the results of `uname`.
-    name_template: >-
-      {{ .ProjectName }}_
-      {{- title .Os }}_
-      {{- if eq .Arch "amd64" }}x86_64
-      {{- else if eq .Arch "386" }}i386
-      {{- else }}{{ .Arch }}{{ end }}
-      {{- if .Arm }}v{{ .Arm }}{{ end }}
-    # use zip for windows archives
-    format_overrides:
-      - goos: windows
-        formats: ['zip']
-
-changelog:
-  sort: asc
-  filters:
-    exclude:
-      - '^docs:'
-      - '^test:'
-
-release:
-  footer: >-
-
-    ---
-
-    Released by [GoReleaser](https://github.com/goreleaser/goreleaser).

CHANGELOG.md

@@ -11,38 +11,6 @@ Before any major/minor/patch bump all unit tests will be run to verify they pass
 
 -   [x]
 
-## [1.4.0] - 2024-11-29
-
-### Added
-
--   new environment variable `Q3RCON_TARGET_HOST` for setting the host the gameserver is on.
-
-### Changed
-
--   environment variable `Q3RCON_HOST` renamed to `Q3RCON_PROXY_HOST`
--   environment variable `Q3RCON_PROXY` renamed to `Q3RCON_TARGET_PORTS`.
--   default session timeout changed from 5 to 20 minutes.
-
-## [1.3.0] - 2024-10-23
-
-### Added
-
--   Add sessionCache for tracking sessions.
--   Functional option `WithStaleTimeout` renamed to `WithSessionTimeout`
-
-## [1.2.0] - 2024-10-19
-
-### Added
-
--   optional function `WithStaleTimeout`, use it to configure the session timeout value.
-    -   it defaults to 5 minutes.
-
-## [1.1.0] - 2024-09-28
-
-### Added
-
--   connection (challenge) requests are now logged.
-
 ## [0.6.0] - 2024-03-21
 
 ### Added

Dockerfile

@@ -1,4 +1,4 @@
-FROM golang:1.24 AS build_image
+FROM golang:1.21 AS build_image
 
 WORKDIR /usr/src/app
 

Makefile

@@ -1,40 +1,2 @@
-PROGRAM = q3rcon-proxy
-
-GO = @go
-BIN_DIR := bin
-
-WINDOWS=$(BIN_DIR)/$(PROGRAM)_windows_amd64.exe
-LINUX=$(BIN_DIR)/$(PROGRAM)_linux_amd64
-VERSION=$(shell git log -n 1 --format=%h)
-
-.DEFAULT_GOAL := build
-
-.PHONY: fmt vet build windows linux test clean
-fmt:        
-	$(GO) fmt ./...
-
-vet: fmt        
-	$(GO) vet ./...
-
-build: vet windows linux | $(BIN_DIR)
-	@echo version: $(VERSION)
-
-windows: $(WINDOWS)
-
-linux: $(LINUX)
-
-
-$(WINDOWS):
-	env GOOS=windows GOARCH=amd64 go build -v -o $(WINDOWS) -ldflags="-s -w -X main.version=$(VERSION)"  ./cmd/$(PROGRAM)/
-
-$(LINUX):
-	env GOOS=linux GOARCH=amd64 go build -v -o $(LINUX) -ldflags="-s -w -X main.version=$(VERSION)"  ./cmd/$(PROGRAM)/
-
-test:
-	$(GO) test ./...
-
-$(BIN_DIR):
-	@mkdir -p $@
-
-clean:
-	@rm -rv $(BIN_DIR)
+go-build:
+	go build ./cmd/q3rcon-proxy/

README.md

@@ -8,12 +8,12 @@ Unfortunately the Q3Rcon engine ties the rcon port to the game servers public po
 
 ### Use
 
-Run one or multiple rcon proxies by setting an environment variable `Q3RCON_TARGET_PORTS`
+Run one or multiple rcon proxies by setting an environment variable `Q3RCON_PROXY`
 
 for example:
 
 ```bash
-export Q3RCON_TARGET_PORTS="20000:28960;20001:28961;20002:28962"
+export Q3RCON_PROXY="20000:28960;20001:28961;20002:28962"
 ```
 
 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.
@@ -32,9 +32,3 @@ Set the log level with environment variable `Q3RCON_LOGLEVEL`:
 
 [lilproxy_url]: https://github.com/dgparker/lilproxy
 [user_link]: https://github.com/dgparker
-
-### Further Notes
-
-For a compatible rcon client also written in Go consider checking out the [Q3 Rcon][q3rcon] package.
-
-[q3rcon]: https://github.com/onyx-and-iris/q3rcon

Taskfile.yml

@@ -1,60 +0,0 @@
-version: '3'
-
-includes:
-  docker: ./docker/Taskfile.docker.yml
-
-vars:
-  PROGRAM: q3rcon-proxy
-  SHELL: '{{if eq .OS "Windows_NT"}}powershell{{end}}'
-  BIN_DIR: bin
-
-  WINDOWS: '{{.BIN_DIR}}/{{.PROGRAM}}_windows_amd64.exe'
-  LINUX: '{{.BIN_DIR}}/{{.PROGRAM}}_linux_amd64'
-  GIT_COMMIT:
-    sh: git log -n 1 --format=%h
-
-tasks:
-  default:
-    desc: Build the q3rcon-proxy project
-    cmds:
-      - task: build
-
-  build:
-    desc: Build the q3rcon-proxy project
-    deps: [vet]
-    cmds:
-      - task: build-windows
-      - task: build-linux
-
-  vet:
-    desc: Vet the code
-    deps: [fmt]
-    cmds:
-      - go vet ./...
-
-  fmt:
-    desc: Fmt the code
-    cmds:
-      - go fmt ./...
-
-  build-windows:
-    desc: Build the q3rcon-proxy project for Windows
-    cmds:
-      - GOOS=windows GOARCH=amd64 go build -o {{.WINDOWS}} -ldflags="-X main.Version={{.GIT_COMMIT}}" ./cmd/{{.PROGRAM}}/
-    internal: true
-
-  build-linux:
-    desc: Build the q3rcon-proxy project for Linux
-    cmds:
-      - GOOS=linux GOARCH=amd64 go build -o {{.LINUX}} -ldflags="-X main.Version={{.GIT_COMMIT}}" ./cmd/{{.PROGRAM}}/
-    internal: true
-
-  test:
-    desc: Run tests
-    cmds:
-      - go test ./...
-
-  clean:
-    desc: Clean the build artifacts
-    cmds:
-      - '{{.SHELL}} rm -r {{.BIN_DIR}}'

cmd/q3rcon-proxy/main.go

@@ -21,53 +21,43 @@ func main() {
 		log.SetLevel(log.Level(logLevel))
 	}
 
-	proxyHost := os.Getenv("Q3RCON_PROXY_HOST")
-	if proxyHost == "" {
-		proxyHost = "0.0.0.0"
-	}
-
-	targetHost := os.Getenv("Q3RCON_TARGET_HOST")
-	if targetHost == "" {
-		targetHost = "127.0.0.1"
-	}
-
-	proxies := os.Getenv("Q3RCON_TARGET_PORTS")
+	proxies := os.Getenv("Q3RCON_PROXY")
 	if proxies == "" {
-		log.Fatal("env Q3RCON_TARGET_PORTS required")
+		log.Fatal("env Q3RCON_PROXY required")
+	}
+
+	host := os.Getenv("Q3RCON_HOST")
+	if host == "" {
+		host = "0.0.0.0"
 	}
 
 	sessionTimeout, err := getEnvInt("Q3RCON_SESSION_TIMEOUT")
 	if err != nil {
 		log.Fatalf("unable to parse Q3RCON_SESSION_TIMEOUT: %s", err.Error())
 	}
-	if sessionTimeout == 0 {
-		sessionTimeout = 20
-	}
 
 	for _, proxy := range strings.Split(proxies, ";") {
-		go start(proxyHost, targetHost, proxy, sessionTimeout)
+		go start(host, proxy, sessionTimeout)
 	}
 
-	<-make(chan struct{})
+	<-make(chan int)
 }
 
-func start(proxyHost, targetHost, ports string, sessionTimeout int) {
-	proxyPort, targetPort := func() (string, string) {
-		x := strings.Split(ports, ":")
+func start(host, proxy string, sessionTimeout int) {
+	port, target := func() (string, string) {
+		x := strings.Split(proxy, ":")
 		return x[0], x[1]
 	}()
 
-	hostAddr := fmt.Sprintf("%s:%s", proxyHost, proxyPort)
-	proxyAddr := fmt.Sprintf("%s:%s", targetHost, targetPort)
-
 	c, err := udpproxy.New(
-		hostAddr, proxyAddr,
+		fmt.Sprintf("%s:%s", host, port),
+		fmt.Sprintf("127.0.0.1:%s", target),
 		udpproxy.WithSessionTimeout(time.Duration(sessionTimeout)*time.Minute))
 	if err != nil {
 		log.Fatal(err)
 	}
 
-	log.Printf("q3rcon-proxy initialized: [proxy] (%s) [target] (%s)", hostAddr, proxyAddr)
+	log.Printf("q3rcon-proxy initialized: [proxy] (%s:%s) [target] (127.0.0.1:%s)", host, port, target)
 
 	log.Fatal(c.ListenAndServe())
 }

docker/Taskfile.docker.yml

@@ -1,26 +0,0 @@
-version: '3'
-
-vars:
-  IMAGE: q3rcon-proxy
-
-tasks:
-  build:
-    desc: Build the Docker image
-    cmds:
-      - docker build -t {{.IMAGE}} -f docker/Dockerfile .
-    dir: .
-
-  login:
-    desc: Login to Github Container Registry
-    cmds:
-      - docker login ghcr.io -u {{.GHCR_USER}} --password-stdin <<< {{.GHCR_TOKEN}}
-    internal: true
-
-  push:
-    desc: Push the Docker image to Github Container Registry
-    deps:
-      - task: build
-      - task: login
-    cmds:
-      - docker tag {{.IMAGE}} ghcr.io/{{.GHCR_USER}}/{{.IMAGE}}:latest
-      - docker push ghcr.io/{{.GHCR_USER}}/{{.IMAGE}}:latest

go.mod

@@ -1,9 +1,7 @@
 module github.com/onyx-and-iris/q3rcon-proxy
 
-go 1.24.0
-
-toolchain go1.24.1
+go 1.18
 
 require github.com/sirupsen/logrus v1.9.3
 
-require golang.org/x/sys v0.31.0 // indirect
+require golang.org/x/sys v0.0.0-20220715151400-c0bba94af5f8 // indirect

go.sum

@@ -8,9 +8,8 @@ github.com/sirupsen/logrus v1.9.3/go.mod h1:naHLuLoDiP4jHNo9R0sCBMtWGeIprob74mVs
 github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
 github.com/stretchr/testify v1.7.0 h1:nwc3DEeHmmLAfoZucVR881uASk0Mfjw8xYJ99tb5CcY=
 github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
+golang.org/x/sys v0.0.0-20220715151400-c0bba94af5f8 h1:0A+M6Uqn+Eje4kHMK80dtF3JCXC4ykBgQG4Fe06QRhQ=
 golang.org/x/sys v0.0.0-20220715151400-c0bba94af5f8/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
-golang.org/x/sys v0.31.0 h1:ioabZlmFYtWhL+TRYpcnNlLwhyxaM9kWTDEmfnprqik=
-golang.org/x/sys v0.31.0/go.mod h1:BJP2sWEmIv4KK5OTEluFJCKSidICx8ciO85XgH3Ak8k=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
 gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c h1:dUUwHk2QECo/6vqA44rthZ8ie2QXMNeKRTHCNY2nXvo=
 gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=

pkg/udpproxy/sessioncache.go

@@ -15,8 +15,8 @@ func newSessionCache() sessionCache {
 	}
 }
 
-// read returns the associated session for an addr
-func (sc *sessionCache) read(addr string) (*session, bool) {
+// Read returns the associated session for an addr
+func (sc *sessionCache) Read(addr string) (*session, bool) {
 	sc.mu.RLock()
 	defer sc.mu.RUnlock()
 
@@ -24,16 +24,16 @@ func (sc *sessionCache) read(addr string) (*session, bool) {
 	return v, ok
 }
 
-// insert adds a session for a given addr.
-func (sc *sessionCache) insert(addr string, session *session) {
+// Upsert overrides the session for a given addr.
+func (sc *sessionCache) Upsert(addr string, session *session) {
 	sc.mu.Lock()
 	defer sc.mu.Unlock()
 
 	sc.data[addr] = session
 }
 
-// delete removes the session for the given addr.
-func (sc *sessionCache) delete(addr string) {
+// Delete removes the session for the given addr.
+func (sc *sessionCache) Delete(addr string) {
 	sc.mu.Lock()
 	defer sc.mu.Unlock()
 

pkg/udpproxy/udpproxy.go

@@ -14,7 +14,7 @@ type Option func(*Client)
 func WithSessionTimeout(timeout time.Duration) Option {
 	return func(c *Client) {
 		if timeout < time.Minute {
-			log.Warnf("cannot set stale session timeout to less than 1 minute.. defaulting to 20 minutes")
+			log.Warnf("cannot set stale session timeout to less than 1 minute.. defaulting to 5 minutes")
 			return
 		}
 
@@ -32,8 +32,8 @@ type Client struct {
 	sessionTimeout time.Duration
 }
 
-func New(proxy, target string, options ...Option) (*Client, error) {
-	laddr, err := net.ResolveUDPAddr("udp", proxy)
+func New(port, target string, options ...Option) (*Client, error) {
+	laddr, err := net.ResolveUDPAddr("udp", port)
 	if err != nil {
 		return nil, err
 	}
@@ -47,7 +47,7 @@ func New(proxy, target string, options ...Option) (*Client, error) {
 		laddr:          laddr,
 		raddr:          raddr,
 		sessionCache:   newSessionCache(),
-		sessionTimeout: 20 * time.Minute,
+		sessionTimeout: 5 * time.Minute,
 	}
 
 	for _, o := range options {
@@ -73,7 +73,7 @@ func (c *Client) ListenAndServe() error {
 			log.Error(err)
 		}
 
-		session, ok := c.sessionCache.read(caddr.String())
+		session, ok := c.sessionCache.Read(caddr.String())
 		if !ok {
 			session, err = newSession(caddr, c.raddr, c.proxyConn)
 			if err != nil {
@@ -81,7 +81,7 @@ func (c *Client) ListenAndServe() error {
 				continue
 			}
 
-			c.sessionCache.insert(caddr.String(), session)
+			c.sessionCache.Upsert(caddr.String(), session)
 		}
 
 		go session.proxyTo(buf[:n])
@@ -94,7 +94,7 @@ func (c *Client) pruneSessions() {
 	for range ticker.C {
 		for _, session := range c.sessionCache.data {
 			if time.Since(session.updateTime) > c.sessionTimeout {
-				c.sessionCache.delete(session.caddr.String())
+				c.sessionCache.Delete(session.caddr.String())
 				log.Tracef("session for %s deleted", session.caddr)
 			}
 		}