Installation Guide

📖 Full Installation Guide

You need Nmap. If you have Kali Linux or Parrot OS installed, you already have Nmap. If not, follow the nmap install guide.

The easiest way to install RustScan is to use one of the packages provided for your system, such as HomeBrew or Yay for Arch Linux.

The most universal way is to use cargo, Rust's built in package manager (think Pip but for Rust). Follow this guide to installing Rust & Cargo.

If you face any issues at all, please leave a GitHub issue. I have only tested this on Linux, so there may be issues for Mac OS or Windows.

Note: sometimes Rust doesn't add Cargo to the path. Please see this issue for how to fix that.

🖥️ Debian / Kali

Download the .deb file from the releases page:

https://github.com/RustScan/RustScan/releases

Run the command dpkg -i on the file.

Note: sometimes you can double click the file to achieve the same result.

Docker 🐳

Docker is the recommended way of installing RustScan. This is because:

• It has a high open file descriptor limit, which is one of the main problems with RustScan. Now you don't have to fiddle around trying to understand your OS.
• It works on all systems, regardless of OS. Even Windows, which we don't officially support.
• The Docker image uses the latest build from Cargo, our main source-of-truth package. This means that you will always be using the latest version.
• No need to install Rust, Cargo, or Nmap.

To install Docker, follow their guide.

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 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 thelatest image is considered experimental.