Skip to content

Commit 20c5728

Browse files
authored
Merge pull request #1792 from drwetter/docker_docu_polish
Consolidate docker sections in Readme.md and Dockerfile.md
2 parents 849c031 + 1a7e4f1 commit 20c5728

2 files changed

Lines changed: 28 additions & 17 deletions

File tree

Dockerfile.md

Lines changed: 22 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,21 @@
1-
## Usage:
1+
## Usage
2+
3+
### From git directory
4+
5+
```
6+
docker build .
7+
```
8+
9+
Catch is when you run without image tags you need to catch the ID when building
10+
11+
```
12+
[..]
13+
---> 889fa2f99933
14+
Successfully built 889fa2f99933
15+
```
16+
17+
More comfortable is
218

3-
(in git directory):
419
```
520
docker build -t mytestssl .
621
docker run --rm -t mytestssl example.com
@@ -13,18 +28,18 @@ docker run -t mytestssl --help
1328
docker run --rm -t mytestssl -p --header example.com
1429
```
1530

16-
or pull the image from dockerhub and run:
31+
### From dockerhub
32+
33+
You can pull the image from dockerhub and run:
1734

1835
```
19-
docker run --rm -t drwetter/testssl.sh --pfs example.com
36+
docker run --rm -t drwetter/testssl.sh --fs example.com
2037
```
2138

22-
Tags supported are: ``latest``, ``stable`` which _for now_ are all the same and point to ``3.0``.
39+
Tags supported are: ``3.1dev`` and ``latest`` are the same, i.e. is the rolling release. ``3.0`` is the latest stable version from git which might have a few improvements over the released 3.0.X.
2340

2441
``docker run --rm -t drwetter/testssl.sh:stable example.com``.
2542

26-
And for the indomitable users who prefer to run old stuff you can use the tag ``2.9.5``. Please note ``2.9dev`` should not be used anymore.
27-
2843
Keep in mind that any output file (--log, --html, --json etc.) will be created in the container. If you wish to have this created in a local directory you can mount a volume into the container and change the output prefix where the container user has write access to, e.g.:
2944

3045
```

Readme.md

Lines changed: 6 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ to get bugfixes, other feedback and more contributions.
4040
Testssl.sh is working on every Linux/BSD distribution out of the box. Latest by 2.9dev
4141
most of the limitations of disabled features from the openssl client are gone
4242
due to bash-socket-based checks. As a result you can also use e.g. LibreSSL or OpenSSL >=
43-
1.1.1 . testssl.sh also works on other unixoid system out of the box, supposed they have
43+
1.1.1 . testssl.sh also works on other unixoid systems out of the box, supposed they have
4444
`/bin/bash` >= version 3.2 and standard tools like sed and awk installed. An implicit
4545
(silent) check for binaries is done when you start testssl.sh . System V needs probably
4646
to have GNU grep installed. MacOS X and Windows (using MSYS2, Cygwin or WSL) work too.
@@ -53,33 +53,29 @@ You can download testssl.sh branch 3.1dev just by cloning this git repository:
5353

5454
git clone --depth 1 https://github.com/drwetter/testssl.sh.git
5555

56-
Think of 3.1dev like a rolling release, see below. For the stable version help yourself by downloading the [ZIP](https://github.com/drwetter/testssl.sh/archive/3.0.2.zip) or [tar.gz](https://github.com/drwetter/testssl.sh/archive/3.0.2.zip) archive. Just ``cd`` to the directory created (=INSTALLDIR) and run it off there.
56+
Think of 3.1dev like a rolling release, see below. For the stable version help yourself by downloading the [ZIP](https://codeload.github.com/drwetter/testssl.sh/zip/3.0.4) or [tar.gz](https://codeload.github.com/drwetter/testssl.sh/tar.gz/3.0.4) archive. Just ``cd`` to the directory created (=INSTALLDIR) and run it off there.
5757

5858
#### Docker
5959

60-
Testssl.sh has minimal requirements. As stated you don't have to install or build anything. You can just run it from the pulled/cloned directory. Still if you don't want to pull the github repo to your directory of choice you can pull a container from dockerhub and run it:
60+
Testssl.sh has minimal requirements. As stated you don't have to install or build anything. You can just run it from the pulled/cloned directory. Still if you don't want to pull the github repo to your directory of choice you can pull a container from dockerhub and run it:
6161

6262
```
6363
docker run --rm -ti drwetter/testssl.sh:3.1dev <your_cmd_line>
6464
```
6565

6666
Or if you have cloned this repo you also can just ``cd`` to the INSTALLDIR and run
6767
```
68-
docker build .
68+
docker build . -t imagefoo && docker run --rm -t imagefoo example.com
6969
```
7070

71-
followed by ``docker run -ti <ID> <your_cmd_line>`` where ``ID`` is the identifier in the last line from the build command like
71+
For more please consult [Dockerfile.md](https://github.com/drwetter/testssl.sh/blob/3.1dev/Dockerfile.md).
7272

73-
```
74-
---> 889fa2f99933
75-
Successfully built 889fa2f99933
76-
```
7773

7874
### Status
7975

8076
We're currently in the development phase, version 3.1dev. 3.1dev will eventually become 3.2. Bigger features are developed in a separate branch before merged into 3.1dev to avoid hiccups or inconsistencies. Albeit we try to keep 3.1dev as solid as possible things will certainly change in 3.1dev. So if you need stability the 3.0 branch is better for you. Think of the 3.1dev branch like a rolling release.
8177

82-
Support for 2.9.5 has been dropped. Supported is 3.0.x only.
78+
Support for 2.9.5 has been dropped. Supported is >= 3.0.x only.
8379

8480
### Documentation
8581

0 commit comments

Comments
 (0)