Public | Automated Build

Last pushed: 8 days ago
Short Description
GoPhish docker container (GoPhish - github.com/gophish/gophish).
Full Description

GoPhish Docker Container

This Docker container runs the "gophish" phishing toolkit.
See the gophish project site at https://getgophish.com/ or the GitHub project at https://github.com/gophish/gophish

Description from the GitHub page:

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.

Tags

The tags associated with this container are:

latest_: the latest release version

release-x.x.x: a specific release version

dev: a build of the latest source commit as at build time

Running

The suggested way of running the container is to use Docker Compose. The docker-compose.yml uses a customised config.json file to enable HTTPS and mounts filesystem files into the container for the config, certificates and the database.

Download the docker-compose.yml and config.json files into /srv/gophish:

git clone https://github.com/scottg88/gophish-compose.git /srv/gophish

Edit the docker-compose.yml file for any environment-specific settings. E.g. update the "volumes" section if you do not like the default locations (also update the location you clone into above).

Copy the "admin" and "phish" certificates to /srv/gophish/ (by default) and update the permissions:

chmod 0600 /srv/gophish/admin.* /srv/gophish/phish.*

Start the container:

docker-compose up -d

Alternatively run the container directly (by default using HTTP and persisting the database to an unnamed volume, see the section on HTTPS for utilising HTTPS):

docker run -d --name gophish -p 3333:3333 -p 80:80 --restart=always scottg88/gophish

Upgrading

Upgrading without Docker Compose and default docker run settings from above:

docker stop gophish
docker rename gophish gophish-old
docker run -d --name gophish -p 3333:3333 -p 80:80 --restart=always --volumes-from=gophish-old scottg88/gophish
docker rm gophish-old

Ensure the container name ("gophish") matches the name used in your environment.

Upgrading with Docker Compose, perform the following from the folder holding docker-compose.yml:

docker-compose stop
docker-compose down
docker-compose pull
docker-compose up -d

Persisting Data

Database

The configuration file (config.json) is modified to place the database file (gophish.db) in a sub-directory. This allows a volume to be defined to persist the gophish database file.

Config snippet:

"db_path" : "database/gophish.db",

A volume is defined in the Dockerfile persisting the database by default. Alternatively mount a volume against "/app/database" with docker run.

HTTPS

To use HTTPS with this container, overwrite the config file with a volume mount at docker run.

Config file: /app/config.json

Example config snippet:

        "admin_server" : {
                "listen_url" : "0.0.0.0:3333",
                "use_tls" : true,
                "cert_path" : "admin.crt",
                "key_path" : "admin.key"
        },
        "phish_server" : {
                "listen_url" : "0.0.0.0:443",
                "use_tls" : true,
                "cert_path" : "phish.crt",
                "key_path": "phish.key"
        },

If using a config.json with the above settings, mount the following files at docker run:

  • /app/admin.crt (admin interface pub key)
  • /app/admin.key (admin interface priv key)
  • /app/phish.crt (phishing interface pub key)
  • /app/phish.key (phishing interface priv key)

Example:

docker run -d --name gophish --restart=always -p 3333:3333 -p 443:443 -v /path/to/config.json:/app/config.json -v /path/to/admin.crt:/app/admin.crt -v /path/to/admin.key:/app/admin.key -v /path/to/phish.crt:/app/phish.crt -v /path/to/phish.key:/app/phish.key scottg88/gophish
Docker Pull Command
Owner
scottg88
Source Repository