1
mirror of https://github.com/rapid7/metasploit-framework synced 2024-10-29 18:07:27 +01:00
metasploit-framework/documentation/modules/module_doc_template.md

46 lines
1.3 KiB
Markdown
Raw Normal View History

2016-02-26 21:30:12 +01:00
The following is the recommended format for module documentation.
But feel free to add more content/sections to this.
2017-02-28 03:08:18 +01:00
One of the general ideas behind these documents is to help someone troubleshoot the module if it were to stop
functioning in 5+ years, so giving links or specific examples can be VERY helpful.
2016-02-26 21:30:12 +01:00
2016-02-26 21:18:24 +01:00
## Vulnerable Application
2017-02-28 03:08:18 +01:00
Instructions to get the vulnerable application. If applicable, include links to the vulnerable install files,
as well as instructions on installing/configuring the environment if it is different than a standard install.
Much of this will come from the PR, and can be copy/pasted.
2016-02-26 21:24:24 +01:00
2016-02-26 21:18:24 +01:00
## Verification Steps
2017-02-28 03:08:18 +01:00
Example steps in this format (is also in the PR):
2016-02-26 21:24:24 +01:00
1. Install the application
2. Start msfconsole
3. Do: ```use [module path]```
4. Do: ```run```
5. You should get a shell.
2016-02-26 21:18:24 +01:00
## Options
2016-02-26 21:24:24 +01:00
**Option name**
2017-02-28 03:08:18 +01:00
Talk about what it does, and how to use it appropriately. If the default value is likely to change, include the default value here.
2016-02-26 21:24:24 +01:00
2016-02-26 21:18:24 +01:00
## Scenarios
### Version of software and OS as applicable
Specific demo of using the module that might be useful in a real world scenario.
2016-02-26 21:24:24 +01:00
```
code or console output
```
2016-02-26 21:43:53 +01: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
```