mirror of
https://github.com/drwetter/testssl.sh.git
synced 2025-10-31 05:45:26 +01:00
83 lines
3.5 KiB
Markdown
83 lines
3.5 KiB
Markdown
## Usage
|
|
|
|
Run the image with `testssl.sh` options appended (default is `--help`). The container entrypoint is already set to `testsl.sh` 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`][docker-docs::cli::cp].
|
|
|
|
## Images
|
|
|
|
### Available at DockerHub and GHCR
|
|
|
|
You can pull the image from either of these registries:
|
|
- DockerHub: [`drwetter/testssl.sh`][image-registry::dockerhub]
|
|
- GHCR: [`ghcr.io/testssl/testssl.sh`][image-registry::ghcr]
|
|
|
|
Supported tags:
|
|
- `3.2` / `latest`
|
|
- `3.0` is the old stable version ([soon to become EOL][testssl::v3p0-eol])
|
|
|
|
### Building the `testssl.sh` container image
|
|
|
|
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 supported:
|
|
- openSUSE Leap ([`Dockerfile`](./Dockerfile)), glibc-based + faster.
|
|
- Alpine ([`Dockerfile`](./Dockerfile.alpine)), musl-based + half the size.
|
|
|
|
The Alpine variant is made available if you need broader platform support, or an image about 30MB smaller at the expense of [slightly slower performance][testssl::base-image-performance].
|
|
|
|
For contributors, if needing context on the [package selection has been documented][testssl::base-image-packages] for each base image.
|
|
|
|
#### Tip - 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
|
|
```
|
|
|
|
> [!NOTE]
|
|
> This will produce a slightly larger image as [`.dockerignore` is not supported with remote build contexts][build::dockerignore-remote-context].
|
|
|
|
---
|
|
|
|
To build the Alpine image instead, additionally provide the ([alternative `Dockerfile`](./Dockerfile.alpine)) via the `--file` option:
|
|
|
|
```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
|
|
```
|
|
|
|
[docker-docs::cli::cp]: https://docs.docker.com/reference/cli/docker/container/cp/
|
|
[image-registry::dockerhub]: https://hub.docker.com/r/drwetter/testssl.sh
|
|
[image-registry::ghcr]: https://github.com/testssl/testssl.sh/pkgs/container/testssl.sh
|
|
[testssl::v3p0-eol]: https://github.com/testssl/testssl.sh/tree/3.0#status
|
|
[testssl::base-image-performance]: https://github.com/testssl/testssl.sh/issues/2422#issuecomment-2841822406
|
|
[testssl::base-image-packages]: https://github.com/testssl/testssl.sh/issues/2422#issuecomment-2841822406
|
|
[build::dockerignore-remote-context]: https://github.com/docker/buildx/issues/3169
|