From 31e0959d6d4041fc75d2e66629529ec3876f259c Mon Sep 17 00:00:00 2001 From: Raymond Nook <59678453+developStorm@users.noreply.github.com> Date: Wed, 22 May 2024 16:27:20 -0700 Subject: [PATCH 1/2] docs: docker usage --- README.md | 19 ++++++++++++++++++- 1 file changed, 18 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 3f53a534..1f30c4a2 100644 --- a/README.md +++ b/README.md @@ -5,8 +5,25 @@ ZGrab is a fast, modular application-layer network scanner designed for completi ZGrab 2.0 contains a new, modular ZGrab framework, which fully supersedes https://github.com/zmap/zgrab. +## Installation -## Building +### With Docker + +You can run ZGrab 2.0 with our official Docker image. For example, to scan a single website using the HTTP module, you can use: + +```shell +echo 'example.com' | docker run --rm -i ghcr.io/zmap/zgrab2 http +``` + +For more complex scanning scenarios, such as using multiple modules or custom configurations, you can create a configuration file and pass it to the container: + +```shell +docker run --rm -i -v /path/to/your/config.ini:/config.ini ghcr.io/zmap/zgrab2 multiple -c /config.ini +``` + +Replace `/path/to/your/config.ini` with the path to your configuration file on the host machine. See follow for more details on configurations. + +### Building from Source For Go 1.17 and later you must build from source: From 8d2bf0422fe1dd9fc2639270da2c78c7ec9365de Mon Sep 17 00:00:00 2001 From: Raymond Nook <59678453+developStorm@users.noreply.github.com> Date: Wed, 5 Jun 2024 15:33:24 -0700 Subject: [PATCH 2/2] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 1f30c4a2..298d1706 100644 --- a/README.md +++ b/README.md @@ -21,7 +21,7 @@ For more complex scanning scenarios, such as using multiple modules or custom co docker run --rm -i -v /path/to/your/config.ini:/config.ini ghcr.io/zmap/zgrab2 multiple -c /config.ini ``` -Replace `/path/to/your/config.ini` with the path to your configuration file on the host machine. See follow for more details on configurations. +Replace `/path/to/your/config.ini` with the path to your configuration file on the host machine. See [Multiple Module Usage](#multiple-module-usage) for more details on configurations. ### Building from Source