Set version 30 and changelog

mendhak · mendhak · commit 0e6b2c7c0636 · 2023-06-03T10:46:00.000+01:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,6 @@
+## Version `30` - 2023-06-03
+* Use `HTTPS_CERT_FILE` and `HTTPS_KEY_FILE` to specify path to a certificate. 
+
 ## Version `29` - 2023-03-16
 * Publishing this image to Github Container Registry. Available at `docker pull ghcr.io/mendhak/http-https-echo:latest`
 
diff --git a/README.md b/README.md
@@ -9,8 +9,8 @@ It comes with various options that can manipulate the response output, see the t
 
 ![browser](https://raw.githubusercontent.com/mendhak/docker-http-https-echo/master/screenshots/screenshot.png)
 
-The image is available on [Docker Hub](https://hub.docker.com/r/mendhak/http-https-echo): `mendhak/http-https-echo:29`  
-The image is available on [Github Container Registry](https://github.com/mendhak/docker-http-https-echo/pkgs/container/http-https-echo): `ghcr.io/mendhak/http-https-echo:29`
+The image is available on [Docker Hub](https://hub.docker.com/r/mendhak/http-https-echo): `mendhak/http-https-echo:30`  
+The image is available on [Github Container Registry](https://github.com/mendhak/docker-http-https-echo/pkgs/container/http-https-echo): `ghcr.io/mendhak/http-https-echo:30`
 
 Please do not use the `:latest` tag as it will break without warning, use a specific version instead.
 
@@ -41,7 +41,7 @@ This image is executed as non root by default and is fully compliant with Kubern
 
 Run with Docker
 
-    docker run -p 8080:8080 -p 8443:8443 --rm -t mendhak/http-https-echo:29
+    docker run -p 8080:8080 -p 8443:8443 --rm -t mendhak/http-https-echo:30
 
 Or run with Docker Compose
 
@@ -58,13 +58,13 @@ You can choose a different internal port instead of 8080 and 8443 with the `HTTP
 
 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:29
+     docker run -e HTTP_PORT=8888 -e HTTPS_PORT=9999 -p 8080:8888 -p 8443:9999 --rm -t mendhak/http-https-echo:30
 
 
 With docker compose, this would be:
 
     my-http-listener:
-        image: mendhak/http-https-echo:29
+        image: mendhak/http-https-echo:30
         environment:
             - HTTP_PORT=8888
             - HTTPS_PORT=9999
@@ -80,7 +80,7 @@ The certificates are at `/app/fullchain.pem` and `/app/privkey.pem`.
 You can use volume mounting to substitute the certificate and private key with your own. 
 
     my-http-listener:
-        image: mendhak/http-https-echo:29
+        image: mendhak/http-https-echo:30
         ports:
             - "8080:8080"
             - "8443:8443"
@@ -95,7 +95,7 @@ You can use the environment variables `HTTPS_CERT_FILE` and `HTTPS_KEY_FILE` to
 
 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:29
+    docker run -e JWT_HEADER=Authentication -p 8080:8080 -p 8443:8443 --rm -it mendhak/http-https-echo:30
 
 
 Now make your request with `Authentication: eyJ...` header (it should also work with the `Authentication: Bearer eyJ...` schema too):
@@ -108,21 +108,21 @@ And in the output you should see a `jwt` section.
 
 In the log output set the environment variable `DISABLE_REQUEST_LOGS` to true, to disable the specific ExpressJS request log lines. The ones like `::ffff:172.17.0.1 - - [03/Jan/2022:21:31:51 +0000] "GET /xyz HTTP/1.1" 200 423 "-" "curl/7.68.0"`.  The JSON output will still appear.
 
-    docker run --rm -e DISABLE_REQUEST_LOGS=true --name http-echo-tests -p 8080:8080 -p 8443:8443 -t mendhak/http-https-echo:29
+    docker run --rm -e DISABLE_REQUEST_LOGS=true --name http-echo-tests -p 8080:8080 -p 8443:8443 -t mendhak/http-https-echo:30
 
 
 ## Do not log specific path
 
 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:8080 -p 8443:8443 --rm -t mendhak/http-https-echo:29
+     docker run -e LOG_IGNORE_PATH=/ping -p 8080:8080 -p 8443:8443 --rm -t mendhak/http-https-echo:30
 
 
 With docker compose, this would be:
 
     my-http-listener:
-        image: mendhak/http-https-echo:29
+        image: mendhak/http-https-echo:30
         environment:
             - LOG_IGNORE_PATH=/ping
         ports:
@@ -153,15 +153,15 @@ Will contain a `json` property in the response/output.
 You can disable new lines in the log output by setting the environment variable `LOG_WITHOUT_NEWLINE`. For example,
 
 ```bash
-docker run -e LOG_WITHOUT_NEWLINE=true -p 8080:8080 -p 8443:8443 --rm -t mendhak/http-https-echo:29
+docker run -e LOG_WITHOUT_NEWLINE=true -p 8080:8080 -p 8443:8443 --rm -t mendhak/http-https-echo:30
 ```
 
 ## Send an empty response
 
 You can disable the JSON output in the response by setting the environment variable `ECHO_BACK_TO_CLIENT`. For example,
 
 ```bash
-docker run -e ECHO_BACK_TO_CLIENT=false -p 8080:8080 -p 8443:8443 --rm -t mendhak/http-https-echo:29
+docker run -e ECHO_BACK_TO_CLIENT=false -p 8080:8080 -p 8443:8443 --rm -t mendhak/http-https-echo:30
 ```
 
 ## Custom status code
@@ -242,7 +242,7 @@ You can have environment variables (that are visible to the echo server's proces
 Pass the `ECHO_INCLUDE_ENV_VARS=1` environment variable in. 
 
 ```bash
-docker run -d --rm -e ECHO_INCLUDE_ENV_VARS=1 --name http-echo-tests -p 8080:8080 -p 8443:8443 -t mendhak/http-https-echo:29
+docker run -d --rm -e ECHO_INCLUDE_ENV_VARS=1 --name http-echo-tests -p 8080:8080 -p 8443:8443 -t mendhak/http-https-echo:30
 ```
 
 Then do a normal request via curl or browser, and you will see the `env` property in the response body.  
diff --git a/docker-compose.yml b/docker-compose.yml
@@ -2,13 +2,10 @@ version: '3'
 services:
 
     my-http-listener:
-        image: mendhak/http-https-echo:29
+        image: mendhak/http-https-echo:30
         environment: 
             - HTTP_PORT=8888
             - HTTPS_PORT=9999
         ports:
             - "8080:8888"
             - "8443:9999"
-        # volumes:
-        #     - /etc/ssl/certs/ssl-cert-snakeoil.pem:/app/fullchain.pem
-        #     - /etc/ssl/private/ssl-cert-snakeoil.key:/app/privkey.pem
