109 lines
4.4 KiB
HTML
109 lines
4.4 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.19
|
|
|
|
</title>
|
|
|
|
<link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
|
|
|
|
<link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
|
|
|
|
<script type="text/javascript" charset="utf-8">
|
|
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="class_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>Metasploit <a href="https://travis-ci.org/rapid7/metasploit-framework"><img src="https://travis-ci.org/rapid7/metasploit-framework.svg?branch=master" alt="Build Status"></a> <a href="https://codeclimate.com/github/rapid7/metasploit-framework"><img src="https://img.shields.io/codeclimate/github/rapid7/metasploit-framework.svg" alt="Code Climate"></a> <a href="https://hub.docker.com/r/metasploitframework/metasploit-framework/"><img src="https://img.shields.io/docker/pulls/metasploitframework/metasploit-framework.svg" alt="Docker Pulls"></a></h1>
|
|
|
|
<p>The Metasploit Framework is released under a BSD-style license. See
|
|
COPYING for more details.</p>
|
|
|
|
<p>The latest version of this software is available from: <a href="https://metasploit.com">https://metasploit.com</a></p>
|
|
|
|
<p>Bug tracking and development information can be found at:
|
|
<a href="https://github.com/rapid7/metasploit-framework">https://github.com/rapid7/metasploit-framework</a></p>
|
|
|
|
<p>New bugs and feature requests should be directed to:
|
|
<a href="https://r-7.co/MSF-BUGv1">https://r-7.co/MSF-BUGv1</a></p>
|
|
|
|
<p>API documentation for writing modules can be found at:
|
|
<a href="https://rapid7.github.io/metasploit-framework/api">https://rapid7.github.io/metasploit-framework/api</a></p>
|
|
|
|
<p>Questions and suggestions can be sent to: Freenode IRC channel or e-mail the metasploit-hackers mailing list</p>
|
|
|
|
<h2>Installing</h2>
|
|
|
|
<p>Generally, you should use <a href="https://github.com/rapid7/metasploit-framework/wiki/Nightly-Installers">the free installer</a>,
|
|
which contains all of the dependencies and will get you up and running with a
|
|
few clicks. See the <a href="https://r-7.co/MSF-DEV">Dev Environment Setup</a> if
|
|
you'd like to deal with dependencies on your own.</p>
|
|
|
|
<h2>Using Metasploit</h2>
|
|
|
|
<p>Metasploit can do all sorts of things. The first thing you'll want to do
|
|
is start <code>msfconsole</code>, but after that, you'll probably be best served by
|
|
reading <a href="https://www.offensive-security.com/metasploit-unleashed/" title="Metasploit Unleashed">Metasploit Unleashed</a>, the <a href="https://metasploit.github.io">great community
|
|
resources</a>, or the <a href="https://github.com/rapid7/metasploit-framework/wiki">wiki</a>.</p>
|
|
|
|
<h2>Contributing</h2>
|
|
|
|
<p>See the <a href="https://github.com/rapid7/metasploit-framework/wiki/Setting-Up-a-Metasploit-Development-Environment" title="Metasploit Development Environment Setup">Dev Environment Setup</a> guide on GitHub, which will
|
|
walk you through the whole process from installing all the
|
|
dependencies, to cloning the repository, and finally to submitting a
|
|
pull request. For slightly more information, see
|
|
<a href="https://github.com/rapid7/metasploit-framework/blob/master/CONTRIBUTING.md">Contributing</a>.</p>
|
|
</div></div>
|
|
|
|
<div id="footer">
|
|
Generated on Tue Apr 23 22:30:00 2019 by
|
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
0.9.19 (ruby-2.3.3).
|
|
</div>
|
|
|
|
</div>
|
|
</body>
|
|
</html> |