mirror of
https://github.com/drwetter/testssl.sh.git
synced 2025-09-02 18:18:29 +02:00
67 lines
2.7 KiB
Markdown
67 lines
2.7 KiB
Markdown
## Usage
|
|
|
|
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.
|
|
|
|
```bash
|
|
docker run --rm -it ghcr.io/testssl/testssl.sh:3.2 --fs github.com
|
|
```
|
|
|
|
### Output files
|
|
|
|
Keep in mind that any output file (_`--log`, `--html`, `--json`, etc._) will be created within the container.
|
|
|
|
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`:
|
|
|
|
```bash
|
|
# Writes the HTML output to the host path: /tmp/example.com_p443-<date>-<time>.html
|
|
docker run --rm -it -v /tmp:/data --workdir /data ghcr.io/testssl/testssl.sh:3.2 --htmlfile ./ example.com
|
|
```
|
|
|
|
**NOTE:**
|
|
- The UID/GID ownership of the file will be created by the container user `testssl` (`1000:1000`), with permissions `644`.
|
|
- 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/).
|
|
|
|
### From DockerHub or GHCR
|
|
|
|
You can pull the image from either of these registries:
|
|
- DockerHub: [`drwetter/testssl.sh`](https://hub.docker.com/r/drwetter/testssl.sh)
|
|
- GHCR: [`ghcr.io/testssl/testssl.sh`](https://github.com/testssl/testssl.sh/pkgs/container/testssl.sh)
|
|
|
|
Supported tags:
|
|
- `3.2` / `latest`
|
|
- `3.0` is the old stable version ([soon to become EOL](https://github.com/testssl/testssl.sh/tree/3.0#status))
|
|
|
|
### Building
|
|
|
|
You can build with a standard `git clone` + `docker build`. Tagging the image will make it easier to reference.
|
|
|
|
```bash
|
|
mkdir /tmp/testssl && cd /tmp/testssl
|
|
git clone --branch 3.2 --depth 1 https://github.com/testssl/testssl.sh .
|
|
docker build --tag localhost/testssl.sh:3.2 .
|
|
```
|
|
|
|
There are two base images available:
|
|
- `Dockerfile` (openSUSE Leap), glibc-based + faster.
|
|
- `Dockerfile-alpine` (Alpine), musl-based + half the size.
|
|
|
|
Alpine is made available if you need broarder platform support or an image about 30MB smaller at the expense of speed.
|
|
|
|
#### Remote build context + `Dockerfile`
|
|
You can build with a single command instead via:
|
|
|
|
```bash
|
|
docker build --tag localhost/testssl.sh:3.2 https://github.com/testssl/testssl.sh.git#3.2
|
|
```
|
|
|
|
This will produce a slightly larger image however as `.dockerignore` is not supported with remote build contexts.
|
|
|
|
If you would like to build the Alpine image instead this way, just provide the alternative `Dockerfile` via `--file`:
|
|
|
|
```bash
|
|
docker build \
|
|
--tag localhost/testssl.sh:3.2-alpine \
|
|
--file https://raw.githubusercontent.com/testssl/testssl.sh/3.2/Dockerfile-alpine \
|
|
https://github.com/testssl/testssl.sh.git#3.2
|
|
```
|