bee-san/RustScan

Wiki Addition

Open

#648 opened on Aug 18, 2024

View on GitHub
 (7 comments) (0 reactions) (0 assignees)Rust (19,268 stars) (1,284 forks)batch import
good first issue

Description

Under Things-you-may-want-to-do-with-RustScan-but-don't-understand-how.md add this section

Exporting Nmap Reports

Create a place on the machine for the output

mkdir -p /report

Give it permissions for docker to write to

chmod 777 /report

Adding the docker options for a mapped file

docker run -it --rm --name rustscan -v /report:/output rustscan/rustscan:2.1.1 -a 10.1.1.2 -- -oA /output/xml

Contributor guide

Tech stack
rustshelldocker
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Basic Docker knowledgeCommand line familiarity
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90
Research direction
Add a new section titled 'Exporting Nmap Reports' to the file 'Things you may want to do with RustScan but don't understand how.md'. Follow the exact steps provided in the issue body: create a directory, set permissions, and run the docker command with volume mount. Check the existing comments (7 so far) for any feedback or modifications suggested by maintainers or contributors.