README.md 2.48 KB
Newer Older
1
Metasploit [![Build Status](https://travis-ci.org/rapid7/metasploit-framework.svg?branch=master)](https://travis-ci.org/rapid7/metasploit-framework) [![Code Climate](https://img.shields.io/codeclimate/github/rapid7/metasploit-framework.svg)](https://codeclimate.com/github/rapid7/metasploit-framework) [![Docker Pulls](https://img.shields.io/docker/pulls/metasploitframework/metasploit-framework.svg)](https://hub.docker.com/r/metasploitframework/metasploit-framework/)
2 3 4 5
==
The Metasploit Framework is released under a BSD-style license. See
COPYING for more details.

Dillon Korman's avatar
Dillon Korman committed
6
The latest version of this software is available from: https://metasploit.com
7 8 9 10

Bug tracking and development information can be found at:
 https://github.com/rapid7/metasploit-framework

11
New bugs and feature requests should be directed to:
Will's avatar
Will committed
12
  https://r-7.co/MSF-BUGv1
13

14 15
API documentation for writing modules can be found at:
  https://rapid7.github.io/metasploit-framework/api
16

17
Questions and suggestions can be sent to: Freenode IRC channel or e-mail the metasploit-hackers mailing list
18 19 20

Installing
--
21

22
Generally, you should use [the free installer](https://github.com/rapid7/metasploit-framework/wiki/Nightly-Installers),
Dillon Korman's avatar
Dillon Korman committed
23
which contains all of the dependencies and will get you up and running with a
Will's avatar
Will committed
24
few clicks. See the [Dev Environment Setup](https://r-7.co/MSF-DEV) if
25
you'd like to deal with dependencies on your own.
26 27 28 29 30

Using Metasploit
--
Metasploit can do all sorts of things. The first thing you'll want to do
is start `msfconsole`, but after that, you'll probably be best served by
31 32
reading [Metasploit Unleashed][unleashed], the [great community
resources](https://metasploit.github.io), or the [wiki].
33 34 35

Contributing
--
Dillon Korman's avatar
Dillon Korman committed
36 37
See the [Dev Environment Setup][wiki-devenv] guide on GitHub, which will
walk you through the whole process from installing all the
38
dependencies, to cloning the repository, and finally to submitting a
Dillon Korman's avatar
Dillon Korman committed
39
pull request. For slightly more information, see
40
[Contributing](https://github.com/rapid7/metasploit-framework/blob/master/CONTRIBUTING.md).
41 42


43
[wiki]: https://github.com/rapid7/metasploit-framework/wiki
44
[wiki-devenv]: https://github.com/rapid7/metasploit-framework/wiki/Setting-Up-a-Metasploit-Development-Environment "Metasploit Development Environment Setup"
45 46
[wiki-start]: https://github.com/rapid7/metasploit-framework/wiki/ "Metasploit Wiki"
[wiki-usage]: https://github.com/rapid7/metasploit-framework/wiki/Using-Metasploit "Using Metasploit"
Will's avatar
Will committed
47
[unleashed]: https://www.offensive-security.com/metasploit-unleashed/ "Metasploit Unleashed"
48 49