Skip to content

Commit

Permalink
Merge pull request #155 from CMNatic/master
Browse files Browse the repository at this point in the history
Updated README to use the rustscan dockerhub alpine image
  • Loading branch information
CMNatic authored Aug 16, 2020
2 parents 4c91e8f + 9452b1f commit 14b6ea9
Showing 1 changed file with 18 additions and 3 deletions.
21 changes: 18 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
| <p align="center"><a href="https://hub.docker.com/r/cmnatic/rustscan">πŸ‹ Docker (Recommended) </a></p> | <p align="center"><a href="https://github.com/RustScan/RustScan/releases">πŸ‘©β€πŸ’» Kali / Debian </p> | <p align="center"><a href="https://aur.archlinux.org/packages/rustscan/">πŸ—οΈ Arch </a></p> | <p align="center"><a href="https://crates.io/crates/rustscan">πŸ”§ Cargo (Universal) </a></p> |
| ---- | ---- | ---- | --- |
| <p align="center"><img src="pictures/docker.png" /></p> | <p align="center"><img src="pictures/kali.png" /></p> | <p align="center"><img src="pictures/arch.png" /></p> | <p align="center"><img src="pictures/rust.png" /></p>
| `docker pull cmnatic/rustscan:debian-buster` <p>[Usage](https://github.com/RustScan/RustScan#docker-whale) | [Read the install guide](https://github.com/brandonskerritt/RustScan/blob/master/README.md#%EF%B8%8F-debian--kali) | `yay -S rustscan` | `cargo install rustscan`
| `docker pull rustscan/rustscan:alpine` <p>[Usage](https://github.com/RustScan/RustScan#docker-whale) | [Read the install guide](https://github.com/brandonskerritt/RustScan/blob/master/README.md#%EF%B8%8F-debian--kali) | `yay -S rustscan` | `cargo install rustscan`

<hr>

Expand Down Expand Up @@ -124,10 +124,20 @@ 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:
```
rustscan/rustscan:alpine
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.

#### To get started:

Simply run this command against the IP you want to target:

```
docker run -it --rm --name rustscan cmnatic/rustscan:debian-buster rustscan 127.0.0.1
docker run -it --rm --name rustscan rustscan/rustscan:alpine <rustscan arguments here> <ip address to scan>
```

Note: this will scan the Docker's localhost, not your own.
Expand All @@ -137,7 +147,7 @@ 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.

```
alias rustscan='docker run -it --rm --name rustscan cmnatic/rustscan:debian-buster rustscan'
alias rustscan='docker run -it --rm --name rustscan rustscan/rustscan:alpine <rustscan arguments here> <ip address to scan>'
```

Then we can:
Expand All @@ -153,6 +163,11 @@ Download the repo:
git clone https://github.com/RustScan/RustScan.git
```

Ensure you navigate to the download location of the repo:
```
cd /path/to/download/RustScan
```

Build away!
```
docker build -t <yourimagename> .
Expand Down

0 comments on commit 14b6ea9

Please sign in to comment.