github.com/edermi/gophish_mods@v0.7.0/README.md (about)

     1  ![gophish logo](https://raw.github.com/gophish/gophish/master/static/images/gophish_purple.png)
     2  
     3  Gophish
     4  =======
     5  
     6  [![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)
     7  
     8  Gophish: Open-Source Phishing Toolkit
     9  
    10  [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.
    11  
    12  ### Install
    13  
    14  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.
    15  
    16  ### Building From Source
    17  **If you are building from source, please note that Gophish requires Go v1.8 or above!**
    18  
    19  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.
    20  
    21  ### Docker
    22  You can also use Gophish via an unofficial Docker container [here](https://hub.docker.com/r/matteoggl/gophish/).
    23  
    24  ### Setup
    25  After running the Gophish binary, open an Internet browser to https://localhost:3333 and login with the default username (admin) and password (gophish).
    26  
    27  ### Documentation
    28  
    29  Documentation can be found on our [site](http://getgophish.com/documentation). Find something missing? Let us know by filing an issue!
    30  
    31  ### Issues
    32  
    33  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.
    34  
    35  ### License
    36  ```
    37  Gophish - Open-Source Phishing Framework
    38  
    39  The MIT License (MIT)
    40  
    41  Copyright (c) 2013 - 2018 Jordan Wright
    42  
    43  Permission is hereby granted, free of charge, to any person obtaining a copy
    44  of this software ("Gophish Community Edition") and associated documentation files (the "Software"), to deal
    45  in the Software without restriction, including without limitation the rights
    46  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
    47  copies of the Software, and to permit persons to whom the Software is
    48  furnished to do so, subject to the following conditions:
    49  
    50  The above copyright notice and this permission notice shall be included in
    51  all copies or substantial portions of the Software.
    52  
    53  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    54  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    55  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    56  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    57  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
    58  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
    59  THE SOFTWARE.
    60  ```