7c55cdc1c8
3 modules got documentation landed in the wrong spot. This also fixes a few typos and improves formatting. |
||
|---|---|---|
| .github | ||
| app | ||
| config | ||
| data | ||
| db | ||
| docker | ||
| documentation | ||
| external | ||
| lib | ||
| modules | ||
| plugins | ||
| script | ||
| scripts | ||
| spec | ||
| test | ||
| tools | ||
| .dockerignore | ||
| .gitignore | ||
| .gitmodules | ||
| .mailmap | ||
| .rspec | ||
| .rubocop.yml | ||
| .ruby-gemset | ||
| .ruby-version | ||
| .simplecov | ||
| .travis.yml | ||
| .yardopts | ||
| CODE_OF_CONDUCT.md | ||
| CONTRIBUTING.md | ||
| COPYING | ||
| Gemfile | ||
| Gemfile.local.example | ||
| Gemfile.lock | ||
| HACKING | ||
| LICENSE | ||
| LICENSE_GEMS | ||
| README.md | ||
| Rakefile | ||
| Vagrantfile | ||
| docker-compose.yml | ||
| metasploit-framework.gemspec | ||
| msfconsole | ||
| msfd | ||
| msfrpc | ||
| msfrpcd | ||
| msfupdate | ||
| msfvenom | ||
README.md
Metasploit 
The Metasploit Framework is released under a BSD-style license. See 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, which contains all of the dependencies and will get you up and running with a few clicks. See the Dev Environment Setup 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, the great community
resources, or the wiki.
Contributing
See the Dev Environment Setup 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.