Skip to content

Commit bf89580

Browse files
authored
docs: Revise Dockerfile instructions
1 parent c1346f2 commit bf89580

1 file changed

Lines changed: 46 additions & 27 deletions

File tree

Dockerfile.md

Lines changed: 46 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,47 +1,66 @@
11
## Usage
22

3-
### From git directory
3+
Run the image with `testssl.sh` options appended (default is `--help`). The container entrypoint is already set to `testsl.sh` as the command for convenience.
44

5-
```
6-
docker build .
5+
```bash
6+
docker run --rm -it ghcr.io/testssl/testssl.sh:3.2 --fs github.com
77
```
88

9-
Catch is when you run without image tags you need to catch the ID when building
9+
### Output files
1010

11-
```
12-
[..]
13-
---> 889fa2f99933
14-
Successfully built 889fa2f99933
15-
```
11+
Keep in mind that any output file (_`--log`, `--html`, `--json`, etc._) will be created within the container.
1612

17-
More comfortable is
13+
Use a volume bind mount to a local host directory to access the files outside of the container. Set a working directory for the container and any options output prefix can then use a relative path, like this example for `--htmfile`:
1814

19-
```
20-
docker build -t mytestssl .
21-
docker run --rm -t mytestssl example.com
15+
```bash
16+
# Writes the HTML output to the host path: /tmp/example.com_p443-<date>-<time>.html
17+
docker run --rm -it -v /tmp:/data --workdir /data ghcr.io/testssl/testssl.sh:3.2 --htmlfile ./ example.com
2218
```
2319

24-
You can also supply command line options like:
20+
**NOTE:**
21+
- The UID/GID ownership of the file will be created by the container user `testssl` (`1000:1000`), with permissions `644`.
22+
- Your host directory must permit the `testssl` container user or group to write to that host volume. You could alternatively use [`docker cp`](https://docs.docker.com/reference/cli/docker/container/cp/).
2523

26-
```
27-
docker run -t mytestssl --help
28-
docker run --rm -t mytestssl -p --header example.com
29-
```
24+
### From DockerHub or GHCR
3025

31-
### From dockerhub or GHCR
26+
You can pull the image from either of these registries:
27+
- DockerHub: [`drwetter/testssl.sh`](https://hub.docker.com/r/drwetter/testssl.sh)
28+
- GHCR: [`ghcr.io/testssl/testssl.sh`](https://github.com/testssl/testssl.sh/pkgs/container/testssl.sh)
3229

33-
You can pull the image from dockerhub or ghcr.io and run:
30+
Supported tags:
31+
- `3.2` / `latest`
32+
- `3.0` is the old stable version ([soon to become EOL](https://github.com/testssl/testssl.sh/tree/3.0#status))
3433

35-
``docker run --rm -t drwetter/testssl.sh --fs example.com`` or ``docker run --rm -t ghcr.io/testssl/testssl.sh --fs example.com``
34+
### Building
3635

37-
Supported tags are: ``3.2`` and ``latest``, which are the same. ``3.0`` is the old stable version which will be retired soon.
36+
You can build with a standard `git clone` + `docker build`. Tagging the image will make it easier to reference.
3837

39-
``docker run --rm -t drwetter/testssl.sh:stable example.com`` or ``docker run --rm -t ghcr.io/testssl/testssl.sh:stable example.com``
38+
```bash
39+
mkdir /tmp/testssl && cd /tmp/testssl
40+
git clone --branch 3.2 --depth 1 https://github.com/testssl/testssl.sh .
41+
docker build --tag localhost/testssl.sh:3.2 .
42+
```
4043

41-
Keep in mind that any output file (--log, --html, --json etc.) will be created within the container. If you wish to have this created in a local directory on your host you can mount a volume into the container and change the output prefix where the container user has write access to, e.g.:
44+
There are two base images available:
45+
- `Dockerfile` (openSUSE Leap), glibc-based + faster.
46+
- `Dockerfile-alpine` (Alpine), musl-based + half the size.
4247

43-
```
44-
docker run --rm -t -v /tmp:/data drwetter/testssl.sh --htmlfile /data/ example.com
48+
Alpine is made available if you need broarder platform support or an image about 30MB smaller at the expense of speed.
49+
50+
#### Remote build context + `Dockerfile`
51+
You can build with a single command instead via:
52+
53+
```bash
54+
docker build --tag localhost/testssl.sh:3.2 https://github.com/testssl/testssl.sh.git#3.2
4555
```
4656

47-
which writes the HTML output to ``/tmp/example.com_p443-<date>-<time>.html.`` The uid/gid is the one from the docker user. Normally the file is 644. testssl.sh's docker container uses a non-root user (usually with user/groupid 1000:1000).
57+
This will produce a slightly larger image however as `.dockerignore` is not supported with remote build contexts.
58+
59+
If you would like to build the Alpine image instead this way, just provide the alternative `Dockerfile` via `--file`:
60+
61+
```bash
62+
docker build \
63+
--tag localhost/testssl.sh:3.2-alpine \
64+
--file https://raw.githubusercontent.com/testssl/testssl.sh/3.2/Dockerfile-alpine \
65+
https://github.com/testssl/testssl.sh.git#3.2
66+
```

0 commit comments

Comments
 (0)