github.com/jonathaningram/gophish@v0.3.1-0.20170829042651-ac3fe6aeae6c/README.md (about) 1 ![gophish logo](https://raw.github.com/gophish/gophish/master/static/images/gophish_purple.png) 2 3 Gophish 4 ======= 5 6 [![Join the chat at https://gitter.im/gophish/gophish](https://badges.gitter.im/gophish/gophish.svg)](https://gitter.im/gophish/gophish?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) 7 8 [![Build Status](https://travis-ci.org/gophish/gophish.svg?branch=master)](https://travis-ci.org/gophish/gophish) [![GoDoc](https://godoc.org/github.com/gophish/gophish?status.svg)](https://godoc.org/github.com/gophish/gophish) 9 10 Gophish: Open-Source Phishing Toolkit 11 12 [Gophish](https://getgophish.com) is an open-source phishing toolkit designed for businesses and penetration testers. It provides the ability to quickly and easily setup and execute phishing engagements and security awareness training. 13 14 ### Current Status 15 **Update 2/19/2017** 16 17 Gophish version 0.2.1 binaries will be released soon! I am just fixing a few final bugs and then I will build the final binaries. 18 19 ### Install 20 21 Installation of Gophish is dead-simple - just download and extract the zip containing the [release for your system](https://github.com/gophish/gophish/releases/), and run the binary. Gophish has binary releases for Windows, Mac, and Linux platforms. 22 23 ### Building From Source 24 **If you are building from source, please note that Gophish requires Go v1.5 or above!** 25 26 To build Gophish from source, simply run ```go get github.com/gophish/gophish``` and ```cd``` into the project source directory. Then, run ```go build```. After this, you should have a binary called ```gophish``` in the current directory. 27 28 ### Docker 29 You can also use Gophish via an unofficial Docker container [here](https://hub.docker.com/r/matteoggl/gophish/). 30 31 ### Setup 32 After running the Gophish binary, open an Internet browser to http://localhost:3333 and login with the default username (admin) and password (gophish). 33 34 ### Documentation 35 36 Documentation can be found on our [site](http://getgophish.com/documentation). Find something missing? Let us know by filing an issue! 37 38 ### Issues 39 40 Find a bug? Want more features? Find something missing in the documentation? Let us know! Please don't hesitate to [file an issue](https://github.com/gophish/gophish/issues/new) and we'll get right on it. 41 42 ### License 43 ``` 44 Gophish - Open-Source Phishing Framework 45 46 The MIT License (MIT) 47 48 Copyright (c) 2013 - 2017 Jordan Wright 49 50 Permission is hereby granted, free of charge, to any person obtaining a copy 51 of this software ("Gophish Community Edition") and associated documentation files (the "Software"), to deal 52 in the Software without restriction, including without limitation the rights 53 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 54 copies of the Software, and to permit persons to whom the Software is 55 furnished to do so, subject to the following conditions: 56 57 The above copyright notice and this permission notice shall be included in 58 all copies or substantial portions of the Software. 59 60 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 61 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 62 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 63 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 64 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 65 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN 66 THE SOFTWARE. 67 ```