Files
metasploit-gs/README.md
T

51 lines
2.3 KiB
Markdown
Raw Normal View History

2015-12-13 00:28:14 +01:00
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)
2012-05-30 10:40:31 -05:00
==
The Metasploit Framework is released under a BSD-style license. See
COPYING for more details.
2015-03-28 14:51:15 -10:00
The latest version of this software is available from: https://metasploit.com
2012-05-30 10:40:31 -05:00
Bug tracking and development information can be found at:
https://github.com/rapid7/metasploit-framework
2015-01-30 14:28:39 -06:00
New bugs and feature requests should be directed to:
http://r-7.co/MSF-BUGv1
2014-12-19 17:25:56 -06:00
API documentation for writing modules can be found at:
https://rapid7.github.io/metasploit-framework/api
2012-05-30 10:40:31 -05:00
2014-12-19 17:25:56 -06:00
Questions and suggestions can be sent to:
https://lists.sourceforge.net/lists/listinfo/metasploit-hackers
2012-05-30 10:40:31 -05:00
Installing
--
2014-04-11 15:55:18 -05:00
2015-03-28 14:51:15 -10:00
Generally, you should use [the free installer](https://www.metasploit.com/download),
2015-03-29 01:08:06 -10:00
which contains all of the dependencies and will get you up and running with a
2014-04-11 15:55:18 -05:00
few clicks. See the [Dev Environment Setup](http://r-7.co/MSF-DEV) if
you'd like to deal with dependencies on your own.
2012-05-30 10:40:31 -05: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
reading [Metasploit Unleashed][unleashed], the [great community
resources](https://metasploit.github.io), or the [wiki].
2012-05-30 10:40:31 -05:00
Contributing
--
2015-03-28 14:51:15 -10:00
See the [Dev Environment Setup][wiki-devenv] guide on GitHub, which will
walk you through the whole process from installing all the
2012-05-30 10:40:31 -05:00
dependencies, to cloning the repository, and finally to submitting a
2015-03-28 14:51:15 -10:00
pull request. For slightly more information, see
2012-11-06 20:18:58 -06:00
[Contributing](https://github.com/rapid7/metasploit-framework/blob/master/CONTRIBUTING.md).
2012-05-30 10:40:31 -05:00
[wiki]: https://github.com/rapid7/metasploit-framework/wiki
2013-06-15 07:12:59 -05:00
[wiki-devenv]: https://github.com/rapid7/metasploit-framework/wiki/Setting-Up-a-Metasploit-Development-Environment "Metasploit Development Environment Setup"
2012-05-30 10:40:31 -05:00
[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]: http://www.offensive-security.com/metasploit-unleashed/ "Metasploit Unleashed"