Files
metasploit-gs/documentation/modules/module_doc_template.md
T

41 lines
809 B
Markdown
Raw Normal View History

2016-02-26 14:30:12 -06:00
The following is the recommended format for module documentation.
But feel free to add more content/sections to this.
2016-02-26 14:18:24 -06:00
## Vulnerable Application
2016-02-26 14:24:24 -06:00
Instructions to get the vulnerable application.
2016-02-26 14:18:24 -06:00
## Verification Steps
2016-02-26 14:24:24 -06:00
Example steps in this format:
1. Install the application
2. Start msfconsole
3. Do: ```use [module path]```
4. Do: ```run```
5. You should get a shell.
2016-02-26 14:18:24 -06:00
## Options
2016-02-26 14:24:24 -06:00
**Option name**
Talk about what it does, and how to use it appropriately.
2016-02-26 14:18:24 -06:00
## Scenarios
2016-03-05 15:17:19 -06:00
Specific demo of using the module that might be useful in a real world scenario.
2016-02-26 14:24:24 -06:00
```
code or console output
```
2016-02-26 14:43:53 -06:00
For example:
To do this specific thing, here's how you do it:
```
msf > use module_name
msf auxiliary(module_name) > set POWERLEVEL >9000
msf auxiliary(module_name) > exploit
```