jenkins-metasploit
137 lines
5.6 KiB
HTML
137 lines
5.6 KiB
HTML
<!DOCTYPE html>
|
|
<html>
|
|
<head>
|
|
<meta charset="UTF-8">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
<title>
|
|
File: README
|
|
|
|
— Documentation by YARD 0.9.37
|
|
|
|
</title>
|
|
|
|
<link rel="stylesheet" href="css/style.css" type="text/css" />
|
|
|
|
<link rel="stylesheet" href="css/common.css" type="text/css" />
|
|
|
|
<script type="text/javascript">
|
|
pathId = "README";
|
|
relpath = '';
|
|
</script>
|
|
|
|
|
|
<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
|
|
|
|
<script type="text/javascript" charset="utf-8" src="js/app.js"></script>
|
|
|
|
|
|
</head>
|
|
<body>
|
|
<div class="nav_wrap">
|
|
<iframe id="nav" src="file_list.html?1"></iframe>
|
|
<div id="resizer"></div>
|
|
</div>
|
|
|
|
<div id="main" tabindex="-1">
|
|
<div id="header">
|
|
<div id="menu">
|
|
|
|
<a href="_index.html">Index</a> »
|
|
<span class="title">File: README</span>
|
|
|
|
</div>
|
|
|
|
<div id="search">
|
|
|
|
<a class="full_list_link" id="class_list_link"
|
|
href="class_list.html">
|
|
|
|
<svg width="24" height="24">
|
|
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
|
|
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
|
|
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
|
|
</svg>
|
|
</a>
|
|
|
|
</div>
|
|
<div class="clear"></div>
|
|
</div>
|
|
|
|
<div id="content"><div id='filecontents'><h1 id="metasploit-framework">Metasploit Framework</h1>
|
|
|
|
<p>The Metasploit Framework is an open-source tool released under a BSD-style license. For detailed licensing information, refer to the <code>COPYING</code> file.</p>
|
|
|
|
<h2 id="latest-version">Latest Version</h2>
|
|
|
|
<p>Access the latest version of Metasploit from the <a href="https://docs.metasploit.com/docs/using-metasploit/getting-started/nightly-installers.html">Nightly Installers</a> page.</p>
|
|
|
|
<h2 id="documentation">Documentation</h2>
|
|
|
|
<p>Comprehensive documentation, including usage guides, is available at <a href="https://docs.metasploit.com/">Metasploit Docs</a>.</p>
|
|
|
|
<h2 id="development-environment">Development Environment</h2>
|
|
|
|
<p>To set up a development environment, visit the <a href="https://docs.metasploit.com/docs/development/get-started/setting-up-a-metasploit-development-environment.html">Development Setup Guide</a>.</p>
|
|
|
|
<h2 id="bug-and-feature-requests">Bug and Feature Requests</h2>
|
|
|
|
<p>Submit bugs and feature requests via the <a href="https://github.com/rapid7/metasploit-framework/issues">GitHub Issues</a> tracker. New submissions can be made through the <a href="https://github.com/rapid7/metasploit-framework/issues/new/choose">MSF-BUGv1 form</a>.</p>
|
|
|
|
<h2 id="api-documentation">API Documentation</h2>
|
|
|
|
<p>For information on writing modules, refer to the <a href="https://docs.metasploit.com/api/">API Documentation</a>.</p>
|
|
|
|
<h2 id="support-and-communication">Support and Communication</h2>
|
|
|
|
<p>For questions and suggestions, you can:</p>
|
|
|
|
<ul>
|
|
<li>Join our <a href="https://github.com/rapid7/metasploit-framework/discussions">GitHub Discussions</a> for community support and general questions</li>
|
|
<li>Join the <a href="https://join.slack.com/t/metasploit/shared_invite/zt-30i688it0-mJsFGT44IMtdeZi1DraamQ">Metasploit Slack</a> for real-time chat</li>
|
|
<li>Submit <a href="https://github.com/rapid7/metasploit-framework/issues">GitHub Issues</a> for bug reports and feature requests</li>
|
|
<li>Follow <a href="https://x.com/metasploit">@metasploit</a> on X or <a href="https://infosec.exchange/@metasploit">@metasploit@infosec.exchange</a> on Mastodon for updates</li>
|
|
</ul>
|
|
|
|
<p><strong>Note:</strong> 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.</p>
|
|
|
|
<h2 id="installing-metasploit">Installing Metasploit</h2>
|
|
|
|
<h3 id="recommended-installation">Recommended Installation</h3>
|
|
|
|
<p>We recommend installation with the <a href="https://docs.metasploit.com/docs/using-metasploit/getting-started/nightly-installers.html#installing-metasploit-on-linux--macos">official Metasploit installers</a> on Linux or macOS. Metasploit is also pre-installed with Kali.</p>
|
|
|
|
<p>For a manual setup, consult the <a href="https://docs.metasploit.com/docs/development/get-started/setting-up-a-metasploit-development-environment.html">Dev Environment Setup</a> guide.</p>
|
|
|
|
<h2 id="using-metasploit">Using Metasploit</h2>
|
|
|
|
<p>To get started with Metasploit:</p>
|
|
|
|
<ol>
|
|
<li><strong>Start <code>msfconsole</code>:</strong> This is the primary interface for interacting with Metasploit.</li>
|
|
<li><strong>Explore Resources:</strong>
|
|
|
|
<ul>
|
|
<li>Visit the <a href="https://docs.metasploit.com/docs/using-metasploit/getting-started/index.html">Using Metasploit</a> section of the documentation.</li>
|
|
</ul></li>
|
|
</ol>
|
|
|
|
<h2 id="contributing">Contributing</h2>
|
|
|
|
<p>To contribute to Metasploit:</p>
|
|
|
|
<ol>
|
|
<li><strong>Setup Development Environment:</strong> Follow the instructions in the <a href="https://docs.metasploit.com/docs/development/get-started/setting-up-a-metasploit-development-environment.html">Development Setup Guide</a> on GitHub.</li>
|
|
<li><strong>Clone the Repository:</strong> Obtain the source code from the official repository.</li>
|
|
<li><strong>Submit a Pull Request:</strong> After making changes, submit a pull request for review. Additional details can be found in the <a href="https://github.com/rapid7/metasploit-framework/blob/master/CONTRIBUTING.md">Contributing Guide</a>.</li>
|
|
</ol>
|
|
</div></div>
|
|
|
|
<div id="footer">
|
|
Generated on Fri May 8 17:01:00 2026 by
|
|
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
0.9.37 (ruby-3.1.5).
|
|
</div>
|
|
|
|
</div>
|
|
</body>
|
|
</html> |