Merge pull request #27 from chmouel/server

.golangci.yml

@@ -28,10 +28,8 @@ linters:
     - gosec
     - gocritic
     - misspell
-    - deadcode
     - gosec
     - govet
-    - ifshort
     - importas
     - makezero
     - nakedret

.goreleaser.yml

@@ -1,6 +1,6 @@
 before:
   hooks:
-    - /bin/sh -c "printf {{.Version }} > misc/version"
+    - /bin/sh -c "printf {{.Version }} > gosmee/templates/version"
 
 builds:
   - env:
@@ -37,7 +37,7 @@ brews:
       name: gosmee
     folder: Formula
     homepage: "https://github.com/chmouel/gosmee"
-    description: gosmee  - smee.io go client
+    description: "gosmee - A webhook and https://smee.io forwarder"
     install: |
       bin.install "gosmee" => "gosmee"
       output = Utils.popen_read("SHELL=bash #{bin}/gosmee completion bash")
@@ -58,7 +58,7 @@ release:
 nfpms:
   - file_name_template: "gosmee-{{.Version}}_{{.Os}}-{{.Arch}}"
     homepage: https://github.com/chmouel/gosmee
-    description: "Gosmee - smee.io forwarder in go"
+    description: "gosmee - A webhook and https://smee.io forwarder"
     maintainer: Chmouel Boudjnah <[email protected]>
     license: Apache 2.0
     formats:
@@ -94,7 +94,7 @@ universal_binaries:
 aurs:
   - name: gosmee-bin
     homepage: "https://github.com/chmouel/gosmee"
-    description: "Gosmee - smee.io forwarder in go"
+    description: "gosmee - A webhook and https://smee.io forwarder"
     maintainers:
       - "Chmouel Boudjnah <[email protected]>"
     license: Apache 2.0

Makefile

@@ -1,28 +1,38 @@
+NAME  := gosmee
 TARGET_URL ?= http://localhost:8080
 SMEE_URL ?= https://smee.io/new
-IMAGE_REGISTRY ?= quay.io/bgirriam/gosmee
 IMAGE_VERSION ?= latest
 MD_FILES := $(shell find . -type f -regex ".*md"  -not -regex '^./vendor/.*'  -not -regex '^./.vale/.*' -not -regex "^./.git/.*" -print)
 
 LDFLAGS := -s -w
 FLAGS += -ldflags "$(LDFLAGS)" -buildvcs=true
+OUTPUT_DIR = bin
 
-all: test lint build docker-build
+all: test lint build
+
+FORCE:
+
+.PHONY: vendor
+vendor:
+	@echo Generating vendor directory
+	@go mod tidy && go mod vendor
+
+$(OUTPUT_DIR)/$(NAME): main.go FORCE
+	go build -mod=vendor $(FLAGS)  -v -o $@ ./$<
+
+$(OUTPUT_DIR)/$(NAME)-aarch64-linux: main.go FORCE
+	env GOARCH=arm64 GOOS=linux	go build -mod=vendor $(FLAGS)  -v -o $@ ./$<
 
 test:
 	@go test ./... -v
 
 clean:
-	@rm -rf bin/gosmee
+	@rm -rf $(OUTPUT_DIR)/gosmee
 
 build: clean
 	@echo "building."
-	@mkdir -p bin/
-	@go build  -v $(FLAGS)  -o bin/gosmee gosmee.go
-
-docker-build:
-	@echo "docker image building."
-	docker buildx build --platform linux/amd64,linux/s390x,linux/ppc64le -f Dockerfile -t ${IMAGE_REGISTRY}:${IMAGE_VERSION} --push .
+	@mkdir -p $(OUTPUT_DIR)/
+	@go build  -v $(FLAGS)  -o $(OUTPUT_DIR)/gosmee main.go
 
 lint: lint-go lint-md
 
@@ -46,7 +56,3 @@ fmt:
 fumpt:
 	@gofumpt -w *.go
 
-.PHONY: vendor
-vendor:
-	@go mod tidy
-	@go mod vendor

README.md

@@ -1,11 +1,17 @@
-# gosmee - smee.io go client
+# gosmee - A webhook forwader/relayer
 
-A command line client for Smee’s webhook payload delivery service in GO.
+gosmee is a webhook forwarder that you can easily run anywhere.
 
 ## Description
 
-Replay message from <https://smee.io/> to a target host. Allowing you to
-easily expose a local dev service to the internet to be consumed by webhooks.
+Gosmee let you relays webhooks from itself (acting as a server) or from <https://smee.io> to your local notebook.
+
+With `gosmee` you can easily expose the service on your local network or behind a VPN, letting a
+public service (ie: GitHub) to push webhooks to it.
+
+For example, if you setup your GitHub Webhook to point to a <https://smee.io/> URL or where `gosmee server` listen to.
+
+You then use the `gosmee client` on your local notebook to get the events from the server and relay it to the local service. So effectively connecting github webhook to your local service on your local workstation.
 
 ## Screenshot
 
@@ -69,20 +75,22 @@ source <(gosmee completion zsh)
 
 ## Usage
 
-You first may want to generate your own smee URL by going to <https://smee.io/new>
+### Client
 
-When you have it the basic usage is the folllowing :
+If you want to use <https://smee.io> you  may want to generate your own smee URL by going to <https://smee.io/new>.
+
+When you have it, the basic usage is the following :
 
 ```shell
-gosmee https://smee.io/aBcDeF https://localhost:8080
+gosmee client https://smee.io/aBcDeF https://localhost:8080
 ```
 
-this will replay all payload comingto to the smee URL on a service running on `http://localhost:8080`
+It will replay all payload coming to to the smee URL on a service running on `http://localhost:8080`
 
 Another option is to be able to save all the replay as a handy shell script :
 
 ```shell
-gosmee --saveDir /tmp/savedreplay https://smee.io/aBcDeF https://localhost:8080
+gosmee client --saveDir /tmp/savedreplay https://smee.io/aBcDeF https://localhost:8080
 ```
 
 What this will do is when you have a new payload comming to your smee URL, gosmee will save the json to
@@ -96,41 +104,54 @@ You can add `--noReplay` if you only want the saving and not replaying.
 
 You will have a pretty colored emoji unless you specify `--nocolor` as argument.
 
-## Kubernetes
-
-You can expose an internal kubernetes deployment or service with gosmee :
-
-```yaml
----
-apiVersion: apps/v1
-kind: Deployment
-metadata:
-  name: gosmee
-spec:
-  replicas: 1
-  selector:
-    matchLabels:
-      app: gosmee
-  template:
-    metadata:
-      labels:
-        app: gosmee
-    spec:
-      containers:
-        - image: ghcr.io/chmouel/gosmee:latest
-          imagePullPolicy: IfNotPresent
-          name: gosmee
-          args:
-            [
-              "--saveDir",
-              "/tmp/save",
-              "https://yousmee.url",
-              "http://deployment.name.namespace.name:PORT_OF_SERVICE",
-            ]
+### Server
+
+With `gosmee server` you can use your own server rather than <https://smee.io>
+as relay. By default `gosmee server` will bind to `localhost` on port `3333`
+which is not very useful. You probably want to expose it to your public IP or
+behind a proxy with the flags `--address` and `--port`.
+
+You really want to secure that endpoint, you can generate some letsencrypt
+certificate and use the `--tls-cert` and `--tls-key` flags to specify them.
+
+To use it you go to your URL and a suffix with your random ID. For example :
+
+<https://myserverurl/RANDOM_ID>
+
+The random ID accepted to the server needs to be at least 8 characters (and you
+really want to be it random).
+
+With `/new` you can easily generate a random ID, ie:
+
+```shell
+% curl http://localhost:3333/new
+http://localhost:3333/NqybHcEi
+```
+
+### Nginx
+
+Running gosmee server behind nginx may require some configuration to work properly.
+Here is a `proxy_pass location` to a locally running gosmee server on port localhost:3333:
+
+```nginx
+    location / {
+        proxy_pass         http://127.0.0.1:3333;
+        proxy_buffering off;
+        proxy_cache off;
+        proxy_set_header Host $host;
+        proxy_set_header Connection '';
+        proxy_http_version 1.1;
+        chunked_transfer_encoding off;
+    }
 ```
 
-the `http://deployment.name.namespace.name:PORT_OF_SERVICE` URL is the URL of
-your internal deployment running on your cluster, for example :
+### Kubernetes
+
+You can expose an internal kubernetes deployment or service with gosmee  by using [this file](./misc/kubernetes-deployment.yaml)
+
+Adjust the SMEE_URL in there to your endpoint
+
+and the `http://deployment.name.namespace.name:PORT_OF_SERVICE` URL is the Kubernetes internal URL of your deployment running on your cluster, for example :
 
    <http://service.namespace:8080>
 

go.mod

@@ -3,23 +3,24 @@ module github.com/chmouel/gosmee
 go 1.19
 
 require (
+	github.com/go-chi/chi/v5 v5.0.7
 	github.com/mattn/go-isatty v0.0.16
 	github.com/mgutz/ansi v0.0.0-20200706080929-d51e80ef957d
 	github.com/mitchellh/mapstructure v1.5.0
-	github.com/r3labs/sse v0.0.0-20210224172625-26fe804710bc
+	github.com/r3labs/sse/v2 v2.8.1
 	github.com/urfave/cli/v2 v2.20.3
 	golang.org/x/text v0.4.0
 	gotest.tools/v3 v3.4.0
 )
 
 require (
 	github.com/cpuguy83/go-md2man/v2 v2.0.2 // indirect
-	github.com/google/go-cmp v0.5.7 // indirect
-	github.com/mattn/go-colorable v0.1.9 // indirect
+	github.com/davecgh/go-spew v1.1.1 // indirect
+	github.com/google/go-cmp v0.5.9 // indirect
+	github.com/mattn/go-colorable v0.1.13 // indirect
 	github.com/russross/blackfriday/v2 v2.1.0 // indirect
 	github.com/xrash/smetrics v0.0.0-20201216005158-039620a65673 // indirect
-	golang.org/x/net v0.0.0-20201021035429-f5854403a974 // indirect
-	golang.org/x/sys v0.0.0-20220811171246-fbc7d0a398ab // indirect
+	golang.org/x/net v0.1.0 // indirect
+	golang.org/x/sys v0.1.0 // indirect
 	gopkg.in/cenkalti/backoff.v1 v1.1.0 // indirect
-	gopkg.in/yaml.v2 v2.4.0 // indirect
 )

go.sum

@@ -1,13 +1,15 @@
 github.com/cpuguy83/go-md2man/v2 v2.0.2 h1:p1EgwI/C7NhT0JmVkwCD2ZBK8j4aeHQX2pMHHBfMQ6w=
 github.com/cpuguy83/go-md2man/v2 v2.0.2/go.mod h1:tgQtvFlXSQOSOSIRvRPT7W67SCa46tRHOmNcaadrF8o=
-github.com/davecgh/go-spew v1.1.0 h1:ZDRjVQ15GmhC3fiQ8ni8+OwkZQO4DARzQgrnXU1Liz8=
 github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
+github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
+github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
+github.com/go-chi/chi/v5 v5.0.7 h1:rDTPXLDHGATaeHvVlLcR4Qe0zftYethFucbjVQ1PxU8=
+github.com/go-chi/chi/v5 v5.0.7/go.mod h1:DslCQbL2OYiznFReuXYUmQ2hGd1aDpCnlMNITLSKoi8=
 github.com/google/go-cmp v0.5.5/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE=
-github.com/google/go-cmp v0.5.7 h1:81/ik6ipDQS2aGcBfIN5dHDB36BwrStyeAQquSYCV4o=
-github.com/google/go-cmp v0.5.7/go.mod h1:n+brtR0CgQNWTVd5ZUFpTBC8YFBDLK/h/bpaJ8/DtOE=
-github.com/mattn/go-colorable v0.1.9 h1:sqDoxXbdeALODt0DAeJCVp38ps9ZogZEAXjus69YV3U=
-github.com/mattn/go-colorable v0.1.9/go.mod h1:u6P/XSegPjTcexA+o6vUJrdnUu04hMope9wVRipJSqc=
-github.com/mattn/go-isatty v0.0.12/go.mod h1:cbi8OIDigv2wuxKPP5vlRcQ1OAZbq2CE4Kysco4FUpU=
+github.com/google/go-cmp v0.5.9 h1:O2Tfq5qg4qc4AmwVlvv0oLiVAGB7enBSJ2x2DqQFi38=
+github.com/google/go-cmp v0.5.9/go.mod h1:17dUlkBOakJ0+DkrSSNjCkIjxS6bF9zb3elmeNGIjoY=
+github.com/mattn/go-colorable v0.1.13 h1:fFA4WZxdEF4tXPZVKMLwD8oUnCTTo08duU7wxecdEvA=
+github.com/mattn/go-colorable v0.1.13/go.mod h1:7S9/ev0klgBDR4GtXTXX8a3vIGJpMovkB8vQcUbaXHg=
 github.com/mattn/go-isatty v0.0.16 h1:bq3VjFmv/sOjHtdEhmkEV4x1AJtvUvOJ2PFAZ5+peKQ=
 github.com/mattn/go-isatty v0.0.16/go.mod h1:kYGgaQfpe5nmfYZH+SKPsOc2e4SrIfOl2e/yFXSvRLM=
 github.com/mgutz/ansi v0.0.0-20200706080929-d51e80ef957d h1:5PJl274Y63IEHC+7izoQE9x6ikvDFZS2mDVS3drnohI=
@@ -16,13 +18,13 @@ github.com/mitchellh/mapstructure v1.5.0 h1:jeMsZIYE/09sWLaz43PL7Gy6RuMjD2eJVyua
 github.com/mitchellh/mapstructure v1.5.0/go.mod h1:bFUtVrKA4DC2yAKiSyO/QUcy7e+RRV2QTWOzhPopBRo=
 github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
 github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
-github.com/r3labs/sse v0.0.0-20210224172625-26fe804710bc h1:zAsgcP8MhzAbhMnB1QQ2O7ZhWYVGYSR2iVcjzQuPV+o=
-github.com/r3labs/sse v0.0.0-20210224172625-26fe804710bc/go.mod h1:S8xSOnV3CgpNrWd0GQ/OoQfMtlg2uPRSuTzcSGrzwK8=
+github.com/r3labs/sse/v2 v2.8.1 h1:lZH+W4XOLIq88U5MIHOsLec7+R62uhz3bIi2yn0Sg8o=
+github.com/r3labs/sse/v2 v2.8.1/go.mod h1:Igau6Whc+F17QUgML1fYe1VPZzTV6EMCnYktEmkNJ7I=
 github.com/russross/blackfriday/v2 v2.1.0 h1:JIOH55/0cWyOuilr9/qlrm0BSXldqnqwMsf35Ld67mk=
 github.com/russross/blackfriday/v2 v2.1.0/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM=
 github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
-github.com/stretchr/testify v1.4.0 h1:2E4SXV/wtOkTonXsotYi4li6zVWxYlZuYNCXe9XRJyk=
-github.com/stretchr/testify v1.4.0/go.mod h1:j7eGeouHqKxXV5pUuKE4zz7dFj8WfuZ+81PSLYec5m4=
+github.com/stretchr/testify v1.7.0 h1:nwc3DEeHmmLAfoZucVR881uASk0Mfjw8xYJ99tb5CcY=
+github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
 github.com/urfave/cli/v2 v2.20.3 h1:lOgGidH/N5loaigd9HjFsOIhXSTrzl7tBpHswZ428w4=
 github.com/urfave/cli/v2 v2.20.3/go.mod h1:1CNUng3PtjQMtRzJO4FMXBQvkGtuYRxxiR9xMa7jMwI=
 github.com/xrash/smetrics v0.0.0-20201216005158-039620a65673 h1:bAn7/zixMGCfxrRTfdpNzjtPYqr8smhKouy9mxVdGPU=
@@ -35,18 +37,18 @@ golang.org/x/mod v0.3.0/go.mod h1:s0Qsj1ACt9ePp/hMypM3fl4fZqREWJwdYDEqhRiZZUA=
 golang.org/x/net v0.0.0-20190404232315-eb5bcb51f2a3/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg=
 golang.org/x/net v0.0.0-20190620200207-3b0461eec859/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s=
 golang.org/x/net v0.0.0-20191116160921-f9c825593386/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s=
-golang.org/x/net v0.0.0-20201021035429-f5854403a974 h1:IX6qOQeG5uLjB/hjjwjedwfjND0hgjPMMyO1RoIXQNI=
 golang.org/x/net v0.0.0-20201021035429-f5854403a974/go.mod h1:sp8m0HH+o8qH0wwXwYZr8TS3Oi6o0r6Gce1SSxlDquU=
+golang.org/x/net v0.1.0 h1:hZ/3BUoy5aId7sCpA/Tc5lt8DkFgdVS2onTpJsZ/fl0=
+golang.org/x/net v0.1.0/go.mod h1:Cx3nUiGt4eDBEyega/BKRp+/AlGL8hYe7U9odMt2Cco=
 golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
 golang.org/x/sync v0.0.0-20201020160332-67f06af15bc9/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
 golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
 golang.org/x/sys v0.0.0-20190412213103-97732733099d/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
-golang.org/x/sys v0.0.0-20200116001909-b77594299b42/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
-golang.org/x/sys v0.0.0-20200223170610-d5e6a3e2c0ae/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
 golang.org/x/sys v0.0.0-20200930185726-fdedc70b468f/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
 golang.org/x/sys v0.0.0-20210119212857-b64e53b001e4/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
-golang.org/x/sys v0.0.0-20220811171246-fbc7d0a398ab h1:2QkjZIsXupsJbJIdSjjUOgWK3aEtzyuh2mPt3l/CkeU=
 golang.org/x/sys v0.0.0-20220811171246-fbc7d0a398ab/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
+golang.org/x/sys v0.1.0 h1:kunALQeHf1/185U1i0GOB/fy1IPRDDpuoOOqRReG57U=
+golang.org/x/sys v0.1.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
 golang.org/x/text v0.3.3/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ=
 golang.org/x/text v0.4.0 h1:BrVqGRd7+k1DiOgtnFvAkoQEWQvBc25ouMJM6429SFg=
@@ -57,13 +59,11 @@ golang.org/x/tools v0.1.0/go.mod h1:xkSsbof2nBLbhDlRMhhhyNLN/zl3eTqcnHD5viDpcZ0=
 golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
 golang.org/x/xerrors v0.0.0-20191011141410-1b5146add898/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
 golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
-golang.org/x/xerrors v0.0.0-20200804184101-5ec99f83aff1 h1:go1bK/D/BFZV2I8cIQd1NKEZ+0owSTG1fDTci4IqFcE=
 golang.org/x/xerrors v0.0.0-20200804184101-5ec99f83aff1/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
 gopkg.in/cenkalti/backoff.v1 v1.1.0 h1:Arh75ttbsvlpVA7WtVpH4u9h6Zl46xuptxqLxPiSo4Y=
 gopkg.in/cenkalti/backoff.v1 v1.1.0/go.mod h1:J6Vskwqd+OMVJl8C33mmtxTBs2gyzfv7UDAkHu8BrjI=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
-gopkg.in/yaml.v2 v2.2.2/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=
-gopkg.in/yaml.v2 v2.4.0 h1:D8xgwECY7CYvx+Y2n4sBz93Jn9JRvxdiyyo8CTfuKaY=
-gopkg.in/yaml.v2 v2.4.0/go.mod h1:RDklbk79AGWmwhnvt/jBztapEOGDOx6ZbXqjP6csGnQ=
+gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
+gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
 gotest.tools/v3 v3.4.0 h1:ZazjZUfuVeZGLAmlKKuyv3IKP5orXcwtOwDQH6YVr6o=
 gotest.tools/v3 v3.4.0/go.mod h1:CtbdzLSsqVhDgMtKsx03ird5YTGB3ar27v0u/yKBW5g=