improve documentation and add docker-compose file

4 files changed, 38 insertions, 5 deletions

diff --git a/Dockerfile b/Dockerfile
index 59e6027..c63e3e5 100644
--- a/Dockerfile
+++ b/Dockerfile
@@ -2,9 +2,8 @@ FROM docker.io/golang:1.20-alpine AS builder
 
 WORKDIR /src/
 COPY go.mod go.sum main.go /src/
-RUN go build
+RUN go build -v
 
 FROM alpine
 COPY --from=builder /src/lolproxy /lolproxy
-EXPOSE 6969
 ENTRYPOINT [ "/lolproxy", "--host", "0.0.0.0:6969" ]
diff --git a/README.md b/README.md
index 586b1f1..2d4e3c7 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,26 @@
 # lolproxy
 
 "some fuckshit that changes your response codes"
+
+## running
+```
+Usage of ./lolproxy:
+  -host string
+        host to bind to (default "localhost:6969")
+  -only404
+        only change status code to 404
+  -upstream string
+        upstream host to proxy to (required)
+```
+example: `./lolproxy --upstream https://example.com`
+
+## docker
+the docker image binds to `0.0.0.0:6969` by default, so you'll need to expose the port (`--port 127.0.0.1:6969:6969`).
+you'll also need to set the upstream as the command
+
+example: `docker run --rm -it -p 127.0.0.1:6969:6969 docker.io/galenguyer/lolproxy --upstream https://example.com`
+
+### docker-compose
+a compose file is also provided for your inconvenience. it can be ran with `docker-compose up --build`
+
+you can also command out the `build` directive and uncomment the `image` directive to use the latest image from docker hub
\ No newline at end of file
diff --git a/docker-compose.yaml b/docker-compose.yaml
new file mode 100644
index 0000000..28a341c
--- /dev/null
+++ b/docker-compose.yaml
@@ -0,0 +1,11 @@
+version: "3"
+
+services:
+  lolproxy:
+    #image: docker.io/galenguyer/lolproxy:latest
+    build: .
+    command:
+      - "--upstream"
+      - "https://example.com"
+    ports:
+      - "127.0.0.1:6969:6969"
diff --git a/main.go b/main.go
index 624c73c..7bea7e5 100644
--- a/main.go
+++ b/main.go
@@ -11,8 +11,8 @@ import (
 
 func main() {
 	host := flag.String("host", "localhost:6969", "host to bind to")
-	upstreamFlag := flag.String("upstream", "", "upstream host to proxy to")
-	only404 := flag.Bool("only404", false, "only change 404 status code")
+	upstreamFlag := flag.String("upstream", "", "upstream host to proxy to (required)")
+	only404 := flag.Bool("only404", false, "only change status code to 404")
 	flag.Parse()
 
 	if *upstreamFlag == "" {
@@ -23,7 +23,7 @@ func main() {
 		log.Fatal(err)
 	}
 	if upstream.Host == "" {
-		log.Fatal("upstream host is required")
+		log.Fatal("upstream host is required (you may be missing the protocol, ie http://)")
 	}
 	if upstream.Scheme == "" {
 		upstream.Scheme = "http"