From 1a7e4f1e925da8ba196afe155ce87ee6a585fa34 Mon Sep 17 00:00:00 2001 From: Dirk Wetter Date: Fri, 27 Nov 2020 16:33:23 +0100 Subject: [PATCH] consolidate docker sections in Readme.md and Dockerfile.md see #1791 --- Dockerfile.md | 29 ++++++++++++++++++++++------- Readme.md | 16 ++++++---------- 2 files changed, 28 insertions(+), 17 deletions(-) diff --git a/Dockerfile.md b/Dockerfile.md index bbdf371..ff79277 100644 --- a/Dockerfile.md +++ b/Dockerfile.md @@ -1,6 +1,21 @@ -## Usage: +## Usage + +### From git directory + +``` +docker build . +``` + +Catch is when you run without image tags you need to catch the ID when building + +``` +[..] +---> 889fa2f99933 +Successfully built 889fa2f99933 +``` + +More comfortable is -(in git directory): ``` docker build -t mytestssl . docker run --rm -t mytestssl example.com @@ -13,18 +28,18 @@ docker run -t mytestssl --help docker run --rm -t mytestssl -p --header example.com ``` -or pull the image from dockerhub and run: +### From dockerhub + +You can pull the image from dockerhub and run: ``` -docker run --rm -t drwetter/testssl.sh --pfs example.com +docker run --rm -t drwetter/testssl.sh --fs example.com ``` -Tags supported are: ``latest``, ``stable`` which _for now_ are all the same and point to ``3.0``. +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. ``docker run --rm -t drwetter/testssl.sh:stable example.com``. -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. - 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.: ``` diff --git a/Readme.md b/Readme.md index b9833c7..3c128b3 100644 --- a/Readme.md +++ b/Readme.md @@ -40,7 +40,7 @@ to get bugfixes, other feedback and more contributions. Testssl.sh is working on every Linux/BSD distribution out of the box. Latest by 2.9dev most of the limitations of disabled features from the openssl client are gone due to bash-socket-based checks. As a result you can also use e.g. LibreSSL or OpenSSL >= -1.1.1 . testssl.sh also works on other unixoid system out of the box, supposed they have +1.1.1 . testssl.sh also works on other unixoid systems out of the box, supposed they have `/bin/bash` >= version 3.2 and standard tools like sed and awk installed. An implicit (silent) check for binaries is done when you start testssl.sh . System V needs probably to have GNU grep installed. MacOS X and Windows (using MSYS2, Cygwin or WSL) work too. @@ -53,11 +53,11 @@ You can download testssl.sh branch 3.1dev just by cloning this git repository: git clone --depth 1 https://github.com/drwetter/testssl.sh.git -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. +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. #### Docker -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: +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: ``` docker run --rm -ti drwetter/testssl.sh:3.1dev @@ -65,21 +65,17 @@ docker run --rm -ti drwetter/testssl.sh:3.1dev Or if you have cloned this repo you also can just ``cd`` to the INSTALLDIR and run ``` -docker build . +docker build . -t imagefoo && docker run --rm -t imagefoo example.com ``` -followed by ``docker run -ti `` where ``ID`` is the identifier in the last line from the build command like +For more please consult [Dockerfile.md](https://github.com/drwetter/testssl.sh/blob/3.1dev/Dockerfile.md). -``` - ---> 889fa2f99933 -Successfully built 889fa2f99933 -``` ### Status 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. -Support for 2.9.5 has been dropped. Supported is 3.0.x only. +Support for 2.9.5 has been dropped. Supported is >= 3.0.x only. ### Documentation