Files
metasploit-gs/documentation
Jack Heysel f951f250f8 Land #19381, Fix gitlab_login scanner
This fixes the gitlab_login scanner so that it uses the proper datastore
options Username and Password which are the standard for login scanners.
Before this fix the scanner was using HttpUsername and HttpPassword and
ignoring the datastore options Username and Password
2024-08-30 08:36:08 -07:00
..

Folder Purpose

This folder is primarily used to hold documentation for Metasploit's various modules, as well as the developers guide at developers_guide.pdf.

Metasploit Developer Documentation

Metasploit is actively supported by a community of hundreds of contributors and thousands of users world-wide. As a result, the accompanying documentation moves quite quickly.

The best source of documentation on Metasploit development is https://docs.metasploit.com/. There are many treasures there, such as:

...and many, many more.

API Documentation

If you are looking for API documentation, you may run rake yard to generate a navigable view of the comment documentation used throughout Metasploit, or visit https://rapid7.github.io/metasploit-framework/api for a recently generated online version.

Contributing

If you would like to contribute to the documentation effort, please see http://yardoc.org/ for details on how to write YARD-compatible comments, and send us a Pull Request with your contribution.