jacob.w.pham.mil
0744c70c72
- Update Twitter references to X in Contact.md and README.md - Add YouTube channel to Contact.md - Remove IRC reference from CONTRIBUTING.md as requested - Address all maintainer suggestions from PR review
53 lines
3.2 KiB
Markdown
53 lines
3.2 KiB
Markdown
# 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](https://docs.metasploit.com/docs/using-metasploit/getting-started/nightly-installers.html) page.
|
|
|
|
## Documentation
|
|
Comprehensive documentation, including usage guides, is available at [Metasploit Docs](https://docs.metasploit.com/).
|
|
|
|
## Development Environment
|
|
To set up a development environment, visit the [Development Setup Guide](https://docs.metasploit.com/docs/development/get-started/setting-up-a-metasploit-development-environment.html).
|
|
|
|
## Bug and Feature Requests
|
|
Submit bugs and feature requests via the [GitHub Issues](https://github.com/rapid7/metasploit-framework/issues) tracker. New submissions can be made through the [MSF-BUGv1 form](https://github.com/rapid7/metasploit-framework/issues/new/choose).
|
|
|
|
## API Documentation
|
|
For information on writing modules, refer to the [API Documentation](https://docs.metasploit.com/api/).
|
|
|
|
## Support and Communication
|
|
For questions and suggestions, you can:
|
|
|
|
- Join our [GitHub Discussions](https://github.com/rapid7/metasploit-framework/discussions) for community support and general questions
|
|
- Join the [Metasploit Slack](https://join.slack.com/t/metasploit/shared_invite/zt-30i688it0-mJsFGT44IMtdeZi1DraamQ) for real-time chat
|
|
- Submit [GitHub Issues](https://github.com/rapid7/metasploit-framework/issues) for bug reports and feature requests
|
|
- Follow [@metasploit](https://x.com/metasploit) on X or [@metasploit@infosec.exchange](https://infosec.exchange/@metasploit) 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](https://docs.metasploit.com/docs/using-metasploit/getting-started/nightly-installers.html#installing-metasploit-on-linux--macos) on Linux or macOS. Metasploit is also pre-installed with Kali.
|
|
|
|
For a manual setup, consult the [Dev Environment Setup](https://docs.metasploit.com/docs/development/get-started/setting-up-a-metasploit-development-environment.html) guide.
|
|
|
|
## Using Metasploit
|
|
|
|
To get started with Metasploit:
|
|
|
|
1. **Start `msfconsole`:** This is the primary interface for interacting with Metasploit.
|
|
2. **Explore Resources:**
|
|
- Visit the [Using Metasploit](https://docs.metasploit.com/docs/using-metasploit/getting-started/index.html) section of the documentation.
|
|
|
|
## Contributing
|
|
|
|
To contribute to Metasploit:
|
|
|
|
1. **Setup Development Environment:** Follow the instructions in the [Development Setup Guide](https://docs.metasploit.com/docs/development/get-started/setting-up-a-metasploit-development-environment.html) on GitHub.
|
|
2. **Clone the Repository:** Obtain the source code from the official repository.
|
|
3. **Submit a Pull Request:** After making changes, submit a pull request for review. Additional details can be found in the [Contributing Guide](https://github.com/rapid7/metasploit-framework/blob/master/CONTRIBUTING.md).
|