2019-09-12 01:48:57 +08:00
Metasploit [![Build Status ](https://travis-ci.org/rapid7/metasploit-framework.svg?branch=master )](https://travis-ci.org/rapid7/metasploit-framework) [![Maintainability ](https://api.codeclimate.com/v1/badges/943e398e619c09568f3f/maintainability )](https://codeclimate.com/github/rapid7/metasploit-framework/maintainability) [![Test Coverage ](https://api.codeclimate.com/v1/badges/943e398e619c09568f3f/test_coverage )](https://codeclimate.com/github/rapid7/metasploit-framework/test_coverage) [![Docker Pulls ](https://img.shields.io/docker/pulls/metasploitframework/metasploit-framework.svg )](https://hub.docker.com/r/metasploitframework/metasploit-framework/)
2012-05-30 23:40:31 +08:00
==
The Metasploit Framework is released under a BSD-style license. See
2019-10-07 15:46:15 +08:00
[COPYING ](COPYING ) for more details.
2012-05-30 23:40:31 +08:00
2022-09-17 00:22:44 +08:00
The latest version of this software is available from: https://docs.metasploit.com/docs/using-metasploit/getting-started/nightly-installers.html
2012-05-30 23:40:31 +08:00
2022-09-17 00:22:44 +08:00
You can find documentation on Metasploit and how to use it at:
https://docs.metasploit.com/
Information about setting up a development environment can be found at:
https://docs.metasploit.com/docs/development/get-started/setting-up-a-metasploit-development-environment.html
Our bug and feature request tracker can be found at:
https://github.com/rapid7/metasploit-framework/issues
2012-05-30 23:40:31 +08:00
2015-01-31 04:28:39 +08:00
New bugs and feature requests should be directed to:
2017-05-17 03:25:30 +08:00
https://r-7.co/MSF-BUGv1
2015-01-31 04:28:39 +08:00
2014-12-20 07:25:56 +08:00
API documentation for writing modules can be found at:
2022-09-17 00:22:44 +08:00
https://docs.metasploit.com/api/
2012-05-30 23:40:31 +08:00
2017-07-20 22:32:52 +08:00
Questions and suggestions can be sent to: Freenode IRC channel or e-mail the metasploit-hackers mailing list
2012-05-30 23:40:31 +08:00
Installing
--
2014-04-12 04:55:18 +08:00
2022-09-17 00:22:44 +08:00
Generally, you should use [the free installer ](https://docs.metasploit.com/docs/using-metasploit/getting-started/nightly-installers.html ),
2015-03-29 19:08:06 +08:00
which contains all of the dependencies and will get you up and running with a
2022-09-17 00:22:44 +08:00
few clicks. See the [Dev Environment Setup ](https://docs.metasploit.com/docs/development/get-started/setting-up-a-metasploit-development-environment.html ) if
2014-04-12 04:55:18 +08:00
you'd like to deal with dependencies on your own.
2012-05-30 23:40:31 +08:00
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
2014-12-21 02:53:34 +08:00
reading [Metasploit Unleashed][unleashed], the [great community
2022-09-17 00:22:44 +08:00
resources](https://metasploit.github.io), or take a look at the
[Using Metasploit ](https://docs.metasploit.com/docs/using-metasploit/basics/using-metasploit.html )
page on the documentation website.
2012-05-30 23:40:31 +08:00
Contributing
--
2022-09-17 00:22:44 +08:00
See the [Dev Environment Setup][devenv] guide on GitHub, which will
2015-03-29 08:51:15 +08:00
walk you through the whole process from installing all the
2012-05-30 23:40:31 +08:00
dependencies, to cloning the repository, and finally to submitting a
2015-03-29 08:51:15 +08:00
pull request. For slightly more information, see
2012-11-07 10:18:58 +08:00
[Contributing ](https://github.com/rapid7/metasploit-framework/blob/master/CONTRIBUTING.md ).
2012-05-30 23:40:31 +08:00
2022-09-17 00:22:44 +08:00
[devenv]: https://docs.metasploit.com/docs/development/get-started/setting-up-a-metasploit-development-environment.html "Metasploit Development Environment Setup"
2017-05-17 03:25:30 +08:00
[unleashed]: https://www.offensive-security.com/metasploit-unleashed/ "Metasploit Unleashed"
2012-05-30 23:40:31 +08:00