Skip to content

Commit f983f58

Browse files
committed
Update references to version 29
1 parent af89c2f commit f983f58

2 files changed

Lines changed: 18 additions & 16 deletions

File tree

README.md

Lines changed: 17 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -4,16 +4,18 @@
44

55

66

7-
8-
[`mendhak/http-https-echo`](https://hub.docker.com/r/mendhak/http-https-echo) is a Docker image that can echo various HTTP request properties back to client, as well as in the Docker container logs.
9-
You can use your own certificates, choose your ports, decode JWT headers and filter out certain paths.
7+
`mendhak/http-https-echo` is a Docker image that can echo various HTTP request properties back to client in the response, as well as in the Docker container logs.
8+
It comes with various options that can manipulate the response output, see the table of contents for a full list.
109

1110
![browser](https://raw.githubusercontent.com/mendhak/docker-http-https-echo/master/screenshots/screenshot.png)
1211

13-
This image is executed as non root by default and is fully compliant with Kubernetes or Openshift deployment.
12+
The image is available on [Docker Hub](https://hub.docker.com/r/mendhak/http-https-echo): `mendhak/http-https-echo:29`
13+
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`
1414

1515
Please do not use the `:latest` tag as it will break without warning, use a specific version instead.
1616

17+
This image is executed as non root by default and is fully compliant with Kubernetes or Openshift deployment.
18+
1719

1820
- [Basic Usage](#basic-usage)
1921
- [Choose your ports](#choose-your-ports)
@@ -39,7 +41,7 @@ Please do not use the `:latest` tag as it will break without warning, use a spec
3941

4042
Run with Docker
4143

42-
docker run -p 8080:8080 -p 8443:8443 --rm -t mendhak/http-https-echo:28
44+
docker run -p 8080:8080 -p 8443:8443 --rm -t mendhak/http-https-echo:29
4345

4446
Or run with Docker Compose
4547

@@ -56,13 +58,13 @@ You can choose a different internal port instead of 8080 and 8443 with the `HTTP
5658

5759
In this example I'm setting http to listen on 8888, and https to listen on 9999.
5860

59-
docker run -e HTTP_PORT=8888 -e HTTPS_PORT=9999 -p 8080:8888 -p 8443:9999 --rm -t mendhak/http-https-echo:28
61+
docker run -e HTTP_PORT=8888 -e HTTPS_PORT=9999 -p 8080:8888 -p 8443:9999 --rm -t mendhak/http-https-echo:29
6062

6163

6264
With docker compose, this would be:
6365

6466
my-http-listener:
65-
image: mendhak/http-https-echo:28
67+
image: mendhak/http-https-echo:29
6668
environment:
6769
- HTTP_PORT=8888
6870
- HTTPS_PORT=9999
@@ -76,7 +78,7 @@ With docker compose, this would be:
7678
Use volume mounting to substitute the certificate and private key with your own. This example uses the snakeoil cert.
7779

7880
my-http-listener:
79-
image: mendhak/http-https-echo:28
81+
image: mendhak/http-https-echo:29
8082
ports:
8183
- "8080:8080"
8284
- "8443:8443"
@@ -90,7 +92,7 @@ Use volume mounting to substitute the certificate and private key with your own.
9092

9193
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.
9294

93-
docker run -e JWT_HEADER=Authentication -p 8080:8080 -p 8443:8443 --rm -it mendhak/http-https-echo:28
95+
docker run -e JWT_HEADER=Authentication -p 8080:8080 -p 8443:8443 --rm -it mendhak/http-https-echo:29
9496

9597

9698
Now make your request with `Authentication: eyJ...` header (it should also work with the `Authentication: Bearer eyJ...` schema too):
@@ -103,21 +105,21 @@ And in the output you should see a `jwt` section.
103105

104106
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.
105107

106-
docker run --rm -e DISABLE_REQUEST_LOGS=true --name http-echo-tests -p 8080:8080 -p 8443:8443 -t mendhak/http-https-echo:28
108+
docker run --rm -e DISABLE_REQUEST_LOGS=true --name http-echo-tests -p 8080:8080 -p 8443:8443 -t mendhak/http-https-echo:29
107109

108110

109111
## Do not log specific path
110112

111113
Set the environment variable `LOG_IGNORE_PATH` to a path you would like to exclude from verbose logging to stdout.
112114
This can help reduce noise from healthchecks in orchestration/infrastructure like Swarm, Kubernetes, ALBs, etc.
113115

114-
docker run -e LOG_IGNORE_PATH=/ping -p 8080:8080 -p 8443:8443 --rm -t mendhak/http-https-echo:28
116+
docker run -e LOG_IGNORE_PATH=/ping -p 8080:8080 -p 8443:8443 --rm -t mendhak/http-https-echo:29
115117

116118

117119
With docker compose, this would be:
118120

119121
my-http-listener:
120-
image: mendhak/http-https-echo:28
122+
image: mendhak/http-https-echo:29
121123
environment:
122124
- LOG_IGNORE_PATH=/ping
123125
ports:
@@ -148,15 +150,15 @@ Will contain a `json` property in the response/output.
148150
You can disable new lines in the log output by setting the environment variable `LOG_WITHOUT_NEWLINE`. For example,
149151

150152
```bash
151-
docker run -e LOG_WITHOUT_NEWLINE=true -p 8080:8080 -p 8443:8443 --rm -t mendhak/http-https-echo:28
153+
docker run -e LOG_WITHOUT_NEWLINE=true -p 8080:8080 -p 8443:8443 --rm -t mendhak/http-https-echo:29
152154
```
153155

154156
## Send an empty response
155157

156158
You can disable the JSON output in the response by setting the environment variable `ECHO_BACK_TO_CLIENT`. For example,
157159

158160
```bash
159-
docker run -e ECHO_BACK_TO_CLIENT=false -p 8080:8080 -p 8443:8443 --rm -t mendhak/http-https-echo:28
161+
docker run -e ECHO_BACK_TO_CLIENT=false -p 8080:8080 -p 8443:8443 --rm -t mendhak/http-https-echo:29
160162
```
161163

162164
## Custom status code
@@ -237,7 +239,7 @@ You can have environment variables (that are visible to the echo server's proces
237239
Pass the `ECHO_INCLUDE_ENV_VARS=1` environment variable in.
238240

239241
```bash
240-
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:28
242+
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
241243
```
242244

243245
Then do a normal request via curl or browser, and you will see the `env` property in the response body.

docker-compose.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ version: '3'
22
services:
33

44
my-http-listener:
5-
image: mendhak/http-https-echo:28
5+
image: mendhak/http-https-echo:29
66
environment:
77
- HTTP_PORT=8888
88
- HTTPS_PORT=9999

0 commit comments

Comments
 (0)