Use specific version and cleanup, and README clarification

mendhak · mendhak · commit ec9937fc8b4d · 2020-12-15T21:06:54.000Z
diff --git a/Dockerfile b/Dockerfile
@@ -1,14 +1,3 @@
-# BUILD
-# docker build \
-# --force-rm=true \
-# -f Dockerfile \
-# -t docker-http-https-echo .
-
-# RUN
-# docker run --rm -it \
-# -p 8080:8080 -p 8443:8443 \
-# docker-http-https-echo
-
 FROM node:14-alpine
 
 WORKDIR /app
diff --git a/README.md b/README.md
@@ -11,11 +11,13 @@ You can use your own certificates, choose your ports, decode JWT headers and fil
 
 This image is executed as non root by default and is fully compliant with Kubernetes or Openshift deployment.
 
+Please do not use the `:latest` tag as it will break without warning, use a specific version instead.
+
 ## Basic Usage
 
 Run with Docker
 
-    docker run -p 8080:8080 -p 8443:8443 --rm -t mendhak/http-https-echo
+    docker run -p 8080:8080 -p 8443:8443 --rm -t mendhak/http-https-echo:15
 
 Or run with Docker Compose
 
@@ -28,17 +30,17 @@ Then, issue a request via your browser or curl, and watch the response, as well
 
 ## Choose your ports
 
-You can choose a different internal port instead of 80 and 443 with the `HTTP_PORT` and `HTTPS_PORT` environment variables.
+You can choose a different internal port instead of 8080 and 8443 with the `HTTP_PORT` and `HTTPS_PORT` environment variables.
 
 In this example I'm setting http to listen on 8888, and https to listen on 9999.
 
-     docker run -e HTTP_PORT=8888 -e HTTPS_PORT=9999 -p 8080:8888 -p 8443:9999 --rm -t mendhak/http-https-echo
+     docker run -e HTTP_PORT=8888 -e HTTPS_PORT=9999 -p 8080:8888 -p 8443:9999 --rm -t mendhak/http-https-echo:15
 
 
 With docker compose, this would be:
 
     my-http-listener:
-        image: mendhak/http-https-echo
+        image: mendhak/http-https-echo:15
         environment:
             - HTTP_PORT=8888
             - HTTPS_PORT=9999
@@ -52,7 +54,7 @@ With docker compose, this would be:
 Use volume mounting to substitute the certificate and private key with your own. This example uses the snakeoil cert.
 
     my-http-listener:
-        image: mendhak/http-https-echo
+        image: mendhak/http-https-echo:15
         ports:
             - "8080:8080"
             - "8443:8443"
@@ -66,7 +68,7 @@ Use volume mounting to substitute the certificate and private key with your own.
 
 If you specify the header that contains the JWT, the echo output will contain the decoded JWT.  Use the `JWT_HEADER` environment variable for this.
 
-    docker run -e JWT_HEADER=Authentication -p 8080:8080 -p 8443:8443 --rm -it mendhak/http-https-echo
+    docker run -e JWT_HEADER=Authentication -p 8080:8080 -p 8443:8443 --rm -it mendhak/http-https-echo:15
 
 
 Now make your request with `Authentication: eyJ...` header (it should also work with the `Authentication: Bearer eyJ...` schema too):
@@ -80,13 +82,13 @@ And in the output you should see a `jwt` section.
 Set the environment variable `LOG_IGNORE_PATH` to a path you would like to exclude from verbose logging to stdout.
 This can help reduce noise from healthchecks in orchestration/infrastructure like Swarm, Kubernetes, ALBs, etc.
 
-     docker run -e LOG_IGNORE_PATH=/ping -p 8080:80 -p 8443:443 --rm -t mendhak/http-https-echo
+     docker run -e LOG_IGNORE_PATH=/ping -p 8080:8080 -p 8443:8443 --rm -t mendhak/http-https-echo:15
 
 
 With docker compose, this would be:
 
     my-http-listener:
-        image: mendhak/http-https-echo
+        image: mendhak/http-https-echo:15
         environment:
             - LOG_IGNORE_PATH=/ping
         ports:
diff --git a/docker-compose.yml b/docker-compose.yml
@@ -1,5 +1,5 @@
 my-http-listener:
-    image: mendhak/http-https-echo
+    image: mendhak/http-https-echo:15
     environment: 
         - HTTP_PORT=8888
         - HTTPS_PORT=9999
diff --git a/tests.sh b/tests.sh
@@ -172,8 +172,8 @@ fi
 message " Stop containers "
 docker stop http-echo-tests 
 
-message " Check that container can run as a NON ROOT USER "
-docker run -d --name http-echo-tests --user node -e HTTP_PORT=8888 -e HTTPS_PORT=9999 -p 8080:8888 -p 8443:9999 --rm mendhak/http-https-echo
+message " Check that container is running as a NON ROOT USER by default"
+docker run -d --name http-echo-tests --rm mendhak/http-https-echo
 
 WHOAMI=$(docker exec http-echo-tests whoami)
 
@@ -185,19 +185,6 @@ else
     exit 1
 fi
 
-message " Make http(s) request, and test the path, method and header. "
-REQUEST=$(curl -s -k -X PUT -H "Arbitrary:Header" -d aaa=bbb https://localhost:8443/hello-world)
-if [ $(echo $REQUEST | jq -r '.path') == '/hello-world' ] && \
-   [ $(echo $REQUEST | jq -r '.method') == 'PUT' ] && \
-   [ $(echo $REQUEST | jq -r '.headers.arbitrary') == 'Header' ] 
-then
-    passed "HTTPS request passed."
-else
-    failed "HTTPS request failed."
-    echo $REQUEST | jq
-    exit 1
-fi
-
 message " Stop containers "
 docker stop http-echo-tests 
 
