Skip to content

Commit 19494a6

Browse files
authored
Merge pull request #1794 from drwetter/drwetter-patch-1
Minor changes to Readme Dockerfile again
2 parents 20c5728 + c88d22a commit 19494a6

File tree

2 files changed

+8
-6
lines changed

2 files changed

+8
-6
lines changed

Dockerfile.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -36,14 +36,14 @@ You can pull the image from dockerhub and run:
3636
docker run --rm -t drwetter/testssl.sh --fs example.com
3737
```
3838

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.
39+
Supported tages are: ``3.1dev`` and ``latest`, which are the same, i.e. the rolling release. ``3.0`` is the latest stable version from git which might have a few improvements (see git log) over the released version 3.0.X.
4040

4141
``docker run --rm -t drwetter/testssl.sh:stable example.com``.
4242

43-
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.:
43+
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.:
4444

4545
```
4646
docker run --rm -t -v /tmp:/data drwetter/testssl.sh --htmlfile /data/ example.com
4747
```
4848

49-
which writes the output to ``/tmp/example.com_p443-<date>-<time>.html.`` The uid/gid is the one from the docker user but normally the file is 644. testssl.sh's docker container uses a non-root user (usually with user/groupid 1000:1000).
49+
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).

Readme.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ Think of 3.1dev like a rolling release, see below. For the stable version help y
6060
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
```
63-
docker run --rm -ti drwetter/testssl.sh:3.1dev <your_cmd_line>
63+
docker run --rm -ti drwetter/testssl.sh <your_cmd_line>
6464
```
6565

6666
Or if you have cloned this repo you also can just ``cd`` to the INSTALLDIR and run
@@ -73,7 +73,9 @@ For more please consult [Dockerfile.md](https://github.com/drwetter/testssl.sh/b
7373

7474
### Status
7575

76-
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.
76+
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. Think of the 3.1dev branch like a rolling release. So if you need stability the 3.0 branch is better for you.
77+
78+
Version 3.0.X receives bugfixes, labeled as 3.0.1, 3.0.2 and so on. This will happen until 3.2 is released.
7779

7880
Support for 2.9.5 has been dropped. Supported is >= 3.0.x only.
7981

@@ -86,7 +88,7 @@ Support for 2.9.5 has been dropped. Supported is >= 3.0.x only.
8688

8789
### Contributing
8890

89-
Contributions are welcome! See [CONTRIBUTING.md](https://github.com/drwetter/testssl.sh/blob/3.0/CONTRIBUTING.md) for details.
91+
Contributions are welcome! See [CONTRIBUTING.md](https://github.com/drwetter/testssl.sh/blob/3.1dev/CONTRIBUTING.md) for details. Please also have a look at the [Coding Convention](https://github.com/drwetter/testssl.sh/blob/3.1dev/Coding_Convention.md}.
9092

9193
### Bug reports
9294

0 commit comments

Comments
 (0)