From 561e7fb2f0c34ad4ff408ac3b8a4fb26b99c9dd6 Mon Sep 17 00:00:00 2001 From: "Ben (CMNatic)" Date: Wed, 16 Sep 2020 01:55:12 +0100 Subject: [PATCH 1/2] Updated README to reflect v1.8.0 DockerHub tag v1.8.0 is the most recent published version of RustScan, the alpine tag quickly became depreciated - meaning people had to rely on `latest` to get any features made within the last month. Version tags will build as per major realease i.e. `v1.9.0` --- README.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index ec0f467b4..f49bf95ff 100644 --- a/README.md +++ b/README.md @@ -24,7 +24,7 @@ |

🐋 Docker (Recommended)

|

👩‍💻 Kali / Debian

|

🏗️ Arch

|

🔧 Cargo (Universal)

| | ----------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | |

|

|

|

| -| `docker pull rustscan/rustscan:alpine`

[Usage](https://github.com/RustScan/RustScan#docker-whale) | [Read the install guide](https://github.com/Rustscan/RustScan/blob/master/README.md#%EF%B8%8F-debian--kali) | `yay -S rustscan` | `cargo install rustscan` | +| `docker pull rustscan/rustscan:v1.8.0`

[Usage](https://github.com/RustScan/RustScan#docker-whale) | [Read the install guide](https://github.com/Rustscan/RustScan/blob/master/README.md#%EF%B8%8F-debian--kali) | `yay -S rustscan` | `cargo install rustscan` |

@@ -130,22 +130,22 @@ To install Docker, [follow their guide](https://docs.docker.com/engine/install/) **Once Docker is installed, you can either build your own image using the `Dockerfile` (alpine) provided in the repo, or alternatively, use the published Docker image like below (most convenient)** -Please see our [DockerHub](https://hub.docker.com/repository/docker/rustscan/rustscan) for further info, however, note that we have two Docker images: +Please see our [DockerHub](https://hub.docker.com/repository/docker/rustscan/rustscan) for further our published versions. However, we recommend using our latest release [v1.8.0](https://github.com/RustScan/RustScan/releases/tag/1.8.0) ``` -rustscan/rustscan:alpine +Stable and supported: rustscan/rustscan:v1.8.0 -rustscan/rustscan:latest +Bleeding edge (run at your own risk!): rustscan/rustscan:latest ``` -We strongly recommend using the `alpine` tag, as this is the latest major - stable - release of RustScan. This READMDE uses the `alpine` image by default, however, note that the`latest` image is considered experimental. +We strongly recommend using the `v1.8.0` tag, as this is the latest major - stable - release of RustScan. This README uses the `v1.8.0` image by default, however, note that the`latest` image is considered experimental. #### To get started: Simply run this command against the IP you want to target: ```bash -docker run -it --rm --name rustscan rustscan/rustscan:alpine +docker run -it --rm --name rustscan rustscan/rustscan:v1.8.0 ``` Note: this will scan the Docker's localhost, not your own. @@ -155,13 +155,13 @@ Once done, you will no longer need to re-download the image (except when RustSca You will have to run this command every time, so we suggest aliasing it to something memorable. ```bash -alias rustscan='docker run -it --rm --name rustscan rustscan/rustscan:alpine' +alias rustscan='docker run -it --rm --name rustscan rustscan/rustscan:v1.8.0' ``` Then we can: ```bash -rustscan 127.0.0.1 -t 500 -b 1500 -- -A +rustscan 192.168.1.0/24 -t 500 -b 1500 -- -A ``` #### To build your own image: From eb905f7e7a372f0080ccb060cfbe01f85f869858 Mon Sep 17 00:00:00 2001 From: "Ben (CMNatic)" Date: Wed, 16 Sep 2020 02:41:11 +0100 Subject: [PATCH 2/2] Update README.md Small typos after initial commit to #224 --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index f49bf95ff..10841f7ef 100644 --- a/README.md +++ b/README.md @@ -138,7 +138,7 @@ Stable and supported: rustscan/rustscan:v1.8.0 Bleeding edge (run at your own risk!): rustscan/rustscan:latest ``` -We strongly recommend using the `v1.8.0` tag, as this is the latest major - stable - release of RustScan. This README uses the `v1.8.0` image by default, however, note that the`latest` image is considered experimental. +We strongly recommend using the `v1.8.0` tag, as this is the latest major - stable - release of RustScan. This README uses the `v1.8.0` image by default, however, note that the `latest` image is considered experimental. #### To get started: @@ -158,7 +158,7 @@ You will have to run this command every time, so we suggest aliasing it to somet alias rustscan='docker run -it --rm --name rustscan rustscan/rustscan:v1.8.0' ``` -Then we can: +Then we can scan: ```bash rustscan 192.168.1.0/24 -t 500 -b 1500 -- -A