File: README.md
Metasploit Framework
The Metasploit Framework is an open-source tool released under a BSD-style license. For detailed licensing information, refer to the COPYING file.
Latest Version
Access the latest version of Metasploit from the Nightly Installers page.
Documentation
Comprehensive documentation, including usage guides, is available at Metasploit Docs.
Development Environment
To set up a development environment, visit the Development Setup Guide.
Bug and Feature Requests
Submit bugs and feature requests via the GitHub Issues tracker. New submissions can be made through the MSF-BUGv1 form.
API Documentation
For information on writing modules, refer to the API Documentation.
Support and Communication
For questions and suggestions, you can:
- Join our GitHub Discussions for community support and general questions
- Join the Metasploit Slack for real-time chat
- Submit GitHub Issues for bug reports and feature requests
- Follow @metasploit on X or @[email protected] on Mastodon for updates
Note: Some community members may still use IRC channels and the metasploit-hackers mailing list, though the primary support channels are now GitHub Discussions and Slack.
Installing Metasploit
Recommended Installation
We recommend installation with the official Metasploit installers on Linux or macOS. Metasploit is also pre-installed with Kali.
For a manual setup, consult the Dev Environment Setup guide.
Using Metasploit
To get started with Metasploit:
- Start
msfconsole: This is the primary interface for interacting with Metasploit. - Explore Resources:
- Visit the Using Metasploit section of the documentation.
Contributing
To contribute to Metasploit:
- Setup Development Environment: Follow the instructions in the Development Setup Guide on GitHub.
- Clone the Repository: Obtain the source code from the official repository.
- Submit a Pull Request: After making changes, submit a pull request for review. Additional details can be found in the Contributing Guide.
File: docs/README.md
Metasploit docs site
This folder maintains the docs for https://docs.metasploit.com/ and https://github.com/rapid7/metasploit-framework/wiki
Architecture
This section explains how the documentation site is generated and deployed.
How it works:
build.rb- The main entry point for generating the docs site from the old Github Wiki format files withinmetasploit-framework.wiki/navigation.rb- Stores the mapping ofmetasploit-framework.wikifiles to the website's navigational structuremetasploit-framework.wiki/- The raw markdown documentation files. Modify these files when updating the site. These files originally came from https://github.com/rapid7/metasploit-framework/wikimetasploit-framework.wiki.old/- A separate clone of https://github.com/rapid7/metasploit-framework/wiki
Behind the scenes, these docs are built and deployed to https://docs.metasploit.com/
Adding pages
You can modify existing documentation files within metasploit-framework.wiki/ with an editor of your choice and send a pull request.
To add a new page, modify navigation.rb. Full details are found beside the NAVIGATION_CONFIG constant.
Adding links
For linking to other docs the Github markdown syntax [[link text|relative_path_to_docs]] is used. Behind the scenes these
links will be verified at build time to ensure there's no 404 links.
Note: It is also possible to use the syntax [[link text|relative_path_to_docs#section]] - but this navigation will happen client side, and
there is no validation that these sections exist at build time. It is possible for future edits to a markdown file to break these links.
Setup
Developer build
Builds the latest docs content from the existing Metasploit Wiki, and
serves the files locally:
cd metasploit-framework/docs
bundle install
bundle exec ruby build.rb --serveNow visit http://127.0.0.1:4000
Production build
Builds the latest docs content from the existing Metasploit Wiki, creates
a production Jekyll build, and serves the files locally:
cd metasploit-framework/docs
bundle install
bundle exec ruby build.rb --production --serve