feat: docs for running gsw with docker

feat: add github workflow for building the container
fix: remove debug due to complexity
fix: set `GSW_LOGGER_OUTPUT_PATHS` in the dockerfile

Author: K3das

.github/workflows/publish-docker.yml

@@ -0,0 +1,49 @@
+name: Build and publish Docker image
+
+on:
+  push:
+    branches:
+      - 'main'
+
+env:
+  REGISTRY: ghcr.io
+  IMAGE_NAME: ${{ github.repository }}
+
+jobs:
+  build-and-push-image:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+      attestations: write
+      id-token: write
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v5
+      - name: Log in to the Container registry
+        uses: docker/login-action@184bdaa0721073962dff0199f1fb9940f07167d1
+        with:
+          registry: ${{ env.REGISTRY }}
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+      - name: Extract metadata (tags, labels) for Docker
+        id: meta
+        uses: docker/metadata-action@c1e51972afc2121e065aed6d45c65596fe445f3f
+        with:
+          images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
+      - name: Build and push Docker image
+        id: push
+        uses: docker/build-push-action@263435318d21b8e681c14492fe198d362a7d2c83
+        with:
+          context: .
+          file: cmd/Containerfile
+          push: true
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}
+      
+      - name: Generate artifact attestation
+        uses: actions/attest-build-provenance@v3
+        with:
+          subject-name: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME}}
+          subject-digest: ${{ steps.push.outputs.digest }}
+          push-to-registry: true

README.md

@@ -12,6 +12,39 @@ You can always run the GSW service by doing a `./gsw_service` after building. Fo
 ### Compatibility
 Some machines do not have a /dev/shm directory. The directory used for shared memory can be changed with the flag `-shm (DIRECTORY_NAME)`. For example, `go run cmd/mem_view/mem_view.go -shm /someDirectory/RAMDrive`.
 
+## Docker
+It may be easier to run the GSW in a docker container. This might be better for compatibility and easier for people on Windows hosts (as docker desktop will natively use a WLS 2 backend).
+
+A dockerfile for GSW is provided in `./cmd/Containerfile` and can be built and run with:
+```shell
+$ docker build -t launch-gsw -f ./cmd/Containerfile .
+```
+
+And the container could be started with:
+```shell
+$ docker run --name gsw-service \
+    -p 11020:11020/udp \
+    -p 13020:13020/udp \
+    -p 12005:12005/udp \
+    -p 12006:12006/udp \
+    -p 12002:12002/udp \
+    launch-gsw
+```
+
+For simplicity, a `docker-compose` file is provided for building and running GSW, Grafana, and InfluxDB:
+```shell
+$ docker compose up --build
+```
+
+### Attaching to the container
+
+If you need to run any of the apps in `cmd/`, you can get a shell into the container using:
+```shell
+$ docker exec -it gsw-service sh
+```
+
+All binaries are in PATH as the names of their folders in `cmd/`.
+
 ## Unit Tests
 There are several unit tests that can be run. You can do a `go test ./...` from the root project directory to execute all tests. It is also recommended to run with the -cover
 flag to get coverage statements.

cmd/Containerfile

@@ -2,10 +2,6 @@ FROM golang:1.25-alpine AS build
 
 RUN apk add --update --no-cache build-base
 
-# TODO: document how to use delve
-RUN --mount=type=cache,target=/root/.cache/go-build \
-    CGO_ENABLED=0 go install -ldflags "-s -w -extldflags '-static'" github.com/go-delve/delve/cmd/dlv@latest
-
 WORKDIR /go/src/app
 
 COPY go.mod .
@@ -16,28 +12,21 @@ RUN --mount=type=cache,id=gsw_mod,target=/go/pkg/mod \
 
 COPY . .
 
-ARG DEBUG=
-ENV USE_DELVE_DEBUG_FLAGS=${DEBUG}
-
 RUN --mount=type=cache,id=gsw_mod,target=/go/pkg/mod \
     --mount=type=cache,id=gsw_build,target=/root/.cache/go-build \
     CGO_ENABLED=1 GOOS=linux go build \
     -trimpath \
-    -o out/gsw_service \
+    -o /build-output/bin/gsw_service \
     -v \
-    # delve
-    ${USE_DELVE_DEBUG_FLAGS:+-gcflags "all=-N -l"} \
     ./cmd/gsw_service.go
 
 RUN --mount=type=cache,id=gsw_mod,target=/go/pkg/mod \
     --mount=type=cache,id=gsw_build,target=/root/.cache/go-build \
     for binary in grafana_live live_setup mem_view pipeline_benchmark telem_view udp_command; do \
         CGO_ENABLED=1 GOOS=linux go build \
         -trimpath \
-        -o out/$binary \
+        -o /build-output/bin/$binary \
         -v \
-        # delve
-        ${USE_DELVE_DEBUG_FLAGS:+-gcflags "all=-N -l"} \
         ./cmd/$binary/; \
     done
 
@@ -46,13 +35,12 @@ FROM alpine
 RUN addgroup -S appgroup && adduser -S appuser -G appgroup
 
 COPY data /opt/app/data
-RUN mkdir -p /opt/app/data/logs && chown -R appuser:appgroup /opt/app/data/logs
-
-COPY --from=build /go/bin/dlv /usr/bin/dlv
-COPY --from=build /go/src/app/out/ /usr/bin/
+COPY --from=build /build-output/bin/ /usr/bin/
 
 WORKDIR /opt/app
 
 USER appuser
 
+ENV GSW_LOGGER_OUTPUT_PATHS=stdout
+
 ENTRYPOINT [ "gsw_service" ]

compose.yaml

@@ -3,16 +3,13 @@ services:
     build:
       context: .
       dockerfile: cmd/Containerfile
-      args:
-        DEBUG: ""
     depends_on:
       influxdb:
         condition: service_started
       grafana:
         condition: service_started
     environment:
       - GSW_DATABASE_HOST_NAME=influxdb
-      - GSW_LOGGER_OUTPUT_PATHS=stdout
     ports:
       - 11020:11020/udp
       - 13020:13020/udp