Open-Source Phishing Toolkit

Go to file

Jordan Wright 33947086b3 Added async option to the API to address async/synch requests until I can migrate all to async		2016-01-24 19:48:15 -06:00
auth	Caused API key to be generated dynamically for admin user. Fixes #60	2016-01-12 20:46:17 -06:00
config	Adding first round of database migrations using goose	2016-01-18 21:13:32 -06:00
controllers	Adding first round of database migrations using goose	2016-01-18 21:13:32 -06:00
db/migrations	Adding first round of database migrations using goose	2016-01-18 21:13:32 -06:00
doc	Adding first draft of CONTRIBUTING file and CLA. Fixes #57	2016-01-13 23:05:17 -06:00
middleware	Update bcrypt dependency and code moved to gophish group	2016-01-10 11:04:03 -06:00
models	Adding first round of database migrations using goose	2016-01-18 21:13:32 -06:00
static	Added async option to the API to address async/synch requests until I can migrate all to async	2016-01-24 19:48:15 -06:00
templates	Temporary fix for stacked buttons to address #92	2016-01-20 23:56:15 -06:00
util	Adding package documentation for util and worker packages	2016-01-16 22:34:02 -06:00
worker	Adding package documentation for util and worker packages	2016-01-16 22:34:02 -06:00
.gitattributes	Fixed csv upload on user import	2015-06-27 19:21:46 -05:00
.gitignore	Working on setting up Login functionality	2014-01-06 00:09:41 -06:00
.travis.yml	Bumped Go version requirement to v1.5 or above	2015-09-15 19:53:15 -05:00
CONTRIBUTING.md	Adding first draft of CONTRIBUTING file and CLA. Fixes #57	2016-01-13 23:05:17 -06:00
LICENSE	Updated copyright	2015-08-05 00:23:20 -05:00
README.md	Added GoDoc reference as well as website link	2016-01-16 23:01:53 -06:00
config.json	Adding first round of database migrations using goose	2016-01-18 21:13:32 -06:00
gophish.go	Added UseTLS config option for both Admin and Phish servers	2016-01-17 10:45:13 -06:00

README.md

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 and security awareness training.

###Current Status Update 01/12/2016

The website is live! This website will contain all the documentation and updates for gophish activity.

Gophish is almost ready for its alpha release, and release 0.1 has been tagged! Just cleaning up some documentation and building the binary releases now. Expect a release announcement next week.

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

Building From Source

If you are building from source, please note that Gophish requires Go v1.5 or above!

To build gophish from source, simply run go get github.com/gophish/gophish followed by go build. You should have a binary called gophish in the current directory.

###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 can be found on our site. 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 and we'll get right on it.

###License

gophish - Open-Source Phishing Framework

The MIT License (MIT)

Copyright (c) 2013 - 2016 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.