mirror of
https://github.com/rapid7/metasploit-framework
synced 2024-10-29 18:07:27 +01:00
50 lines
2.7 KiB
Markdown
50 lines
2.7 KiB
Markdown
Metasploit [](https://travis-ci.org/rapid7/metasploit-framework) [](https://codeclimate.com/github/rapid7/metasploit-framework/maintainability) [](https://codeclimate.com/github/rapid7/metasploit-framework/test_coverage) [](https://hub.docker.com/r/metasploitframework/metasploit-framework/)
|
|
==
|
|
The Metasploit Framework is released under a BSD-style license. See
|
|
[COPYING](COPYING) for more details.
|
|
|
|
The latest version of this software is available from: https://metasploit.com
|
|
|
|
Bug tracking and development information can be found at:
|
|
https://github.com/rapid7/metasploit-framework
|
|
|
|
New bugs and feature requests should be directed to:
|
|
https://r-7.co/MSF-BUGv1
|
|
|
|
API documentation for writing modules can be found at:
|
|
https://rapid7.github.io/metasploit-framework/api
|
|
|
|
Questions and suggestions can be sent to: Freenode IRC channel or e-mail the metasploit-hackers mailing list
|
|
|
|
Installing
|
|
--
|
|
|
|
Generally, you should use [the free installer](https://github.com/rapid7/metasploit-framework/wiki/Nightly-Installers),
|
|
which contains all of the dependencies and will get you up and running with a
|
|
few clicks. See the [Dev Environment Setup](https://r-7.co/MSF-DEV) if
|
|
you'd like to deal with dependencies on your own.
|
|
|
|
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
|
|
reading [Metasploit Unleashed][unleashed], the [great community
|
|
resources](https://metasploit.github.io), or the [wiki].
|
|
|
|
Contributing
|
|
--
|
|
See the [Dev Environment Setup][wiki-devenv] 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
|
|
[Contributing](https://github.com/rapid7/metasploit-framework/blob/master/CONTRIBUTING.md).
|
|
|
|
|
|
[wiki]: https://github.com/rapid7/metasploit-framework/wiki
|
|
[wiki-devenv]: https://github.com/rapid7/metasploit-framework/wiki/Setting-Up-a-Metasploit-Development-Environment "Metasploit Development Environment Setup"
|
|
[wiki-start]: https://github.com/rapid7/metasploit-framework/wiki/ "Metasploit Wiki"
|
|
[wiki-usage]: https://github.com/rapid7/metasploit-framework/wiki/Using-Metasploit "Using Metasploit"
|
|
[unleashed]: https://www.offensive-security.com/metasploit-unleashed/ "Metasploit Unleashed"
|
|
|
|
|