gophish/README.md

![gophish logo](https://raw.github.com/jordan-wright/gophish/master/static/images/gophish_purple.png)

gophish
=======

[![Build Status](https://travis-ci.org/jordan-wright/gophish.svg?branch=master)](https://travis-ci.org/jordan-wright/gophish)

Open-Source Phishing Toolkit

Gophish 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.

###Current Status
**Update 08/15/2015 - Finishing up a rewrite of the frontend to jQuery. Should be fairly stable, but bear with me as things are finished up**

Development of gophish is currently ongoing. It is not anywhere close to being functional yet, but should get there soon.

Until then, you can keep up-to-date with development news and articles on [my blog](http://jordan-wright.github.io/blog/categories/gophish/).

###Install

Installation of gophish is dead-simple - once the binaries are released (coming soon!), just download and extract the zip, and run the binary. Gophish will have binary releases for all platforms.

* If you are building from source, please note that Gophish requires Go v1.5 or above!*
###Setup
After running the gophish binary, open an Internet browser to http://localhost:3333 and login with the default username (admin) and password (gophish).

###Documentation

Documentation is a work in progress. Existing documentation can be found in the [wiki](https://github.com/jordan-wright/gophish/wiki). Find something missing? Let us know by filing an issue!

###Issues

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/jordan-wright/gophish/issues/new) and we'll get right on it.

###License
gophish - Open-Source Phishing Framework

The MIT License (MIT)

Copyright (c) 2013 - 2015 Jordan Wright

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software ("Gophish Community Edition") and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
Testing new README logo 2014-07-12 19:18:46 +00:00			`![gophish logo](https://raw.github.com/jordan-wright/gophish/master/static/images/gophish_purple.png)`
Added logo to readme 2013-12-03 04:59:29 +00:00
Initial commit 2013-11-18 23:26:43 +00:00			`gophish`
			`=======`

Added travis-ci build status to README.md 2015-08-16 04:16:47 +00:00			`[![Build Status](https://travis-ci.org/jordan-wright/gophish.svg?branch=master)](https://travis-ci.org/jordan-wright/gophish)`

Initial commit 2013-11-18 23:26:43 +00:00			`Open-Source Phishing Toolkit`
Initial commit - getting the ball rolling! 2013-12-03 04:56:55 +00:00
Fixed README typo 2014-07-12 18:43:35 +00:00			`Gophish 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.`
Initial commit - getting the ball rolling! 2013-12-03 04:56:55 +00:00
			`###Current Status`
Updated README 2015-08-15 21:06:52 +00:00			`Update 08/15/2015 - Finishing up a rewrite of the frontend to jQuery. Should be fairly stable, but bear with me as things are finished up`

Initial commit - getting the ball rolling! 2013-12-03 04:56:55 +00:00			`Development of gophish is currently ongoing. It is not anywhere close to being functional yet, but should get there soon.`

			`Until then, you can keep up-to-date with development news and articles on [my blog](http://jordan-wright.github.io/blog/categories/gophish/).`

			`###Install`

Updated README 2014-01-12 02:47:24 +00:00			`Installation of gophish is dead-simple - once the binaries are released (coming soon!), just download and extract the zip, and run the binary. Gophish will have binary releases for all platforms.`
Initial commit - getting the ball rolling! 2013-12-03 04:56:55 +00:00
Bumped Go version requirement to v1.5 or above 2015-09-16 00:53:15 +00:00			`* If you are building from source, please note that Gophish requires Go v1.5 or above!*`
Initial commit - getting the ball rolling! 2013-12-03 04:56:55 +00:00			`###Setup`
Updated README Added CSRF Protection to login, /api/reset functions Added auto highlighting of API key when clicked 2014-02-03 23:21:56 +00:00			`After running the gophish binary, open an Internet browser to http://localhost:3333 and login with the default username (admin) and password (gophish).`
Initial commit - getting the ball rolling! 2013-12-03 04:56:55 +00:00
Added documentation and issues in the readme 2015-02-21 17:45:49 +00:00			`###Documentation`

How do I even absolute link? 2015-02-21 17:46:56 +00:00			`Documentation is a work in progress. Existing documentation can be found in the [wiki](https://github.com/jordan-wright/gophish/wiki). Find something missing? Let us know by filing an issue!`
Added documentation and issues in the readme 2015-02-21 17:45:49 +00:00
			`###Issues`

How do I even absolute link? 2015-02-21 17:46:56 +00:00			`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/jordan-wright/gophish/issues/new) and we'll get right on it.`
Added documentation and issues in the readme 2015-02-21 17:45:49 +00:00
Initial commit - getting the ball rolling! 2013-12-03 04:56:55 +00:00			`###License`
			`gophish - Open-Source Phishing Framework`

			`The MIT License (MIT)`

Updating README to reflect new copyright dates. 2015-02-18 02:50:27 +00:00			`Copyright (c) 2013 - 2015 Jordan Wright`
Initial commit - getting the ball rolling! 2013-12-03 04:56:55 +00:00
			`Permission is hereby granted, free of charge, to any person obtaining a copy`
Updated copyright 2015-08-05 05:23:20 +00:00			`of this software ("Gophish Community Edition") and associated documentation files (the "Software"), to deal`
Initial commit - getting the ball rolling! 2013-12-03 04:56:55 +00:00			`in the Software without restriction, including without limitation the rights`
			`to use, copy, modify, merge, publish, distribute, sublicense, and/or sell`
			`copies of the Software, and to permit persons to whom the Software is`
			`furnished to do so, subject to the following conditions:`

			`The above copyright notice and this permission notice shall be included in`
			`all copies or substantial portions of the Software.`

			`THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR`
			`IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,`
			`FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE`
			`AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER`
			`LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,`
			`OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN`
Updating README to reflect new copyright dates. 2015-02-18 02:50:27 +00:00			`THE SOFTWARE.`