README.md

gophish-docker 🎣🐳

Docker Image

Creates a Docker container with an installation of the gophish phishing framework.

Running

Running with Docker

To run the cisagov/gophish image via Docker:

docker run cisagov/gophish:0.0.8

Running with Docker Compose

1. Create a docker-compose.yml file similar to the one below to use Docker Compose.

   ---
   version: "3.7"
   
   services:
     gophish:
       image: cisagov/gophish:0.0.8
       ports:
         - target: 3333
           published: 3333
           protocol: tcp
           mode: host
         - target: 8080
           published: 3380
           protocol: tcp
           mode: host

2. Start the container and detach:

   docker compose up --detach

Using secrets with your container

This container also supports passing sensitive values via Docker secrets. Passing sensitive values like your credentials can be more secure using secrets than using environment variables. See the secrets section below for a table of all supported secret files.

1. To use secrets, create a file or files containing the values you want set.

2. Then add the secret or secrets to your docker-compose.yml file:

   ---
   version: "3.7"
   
   secrets:
     config_json:
       file: ./src/secrets/config.json
     admin_fullchain_pem:
       file: ./src/secrets/admin_fullchain.pem
     admin_privkey_pem:
       file: ./src/secrets/admin_privkey.pem
     phish_fullchain_pem:
       file: ./src/secrets/phish_fullchain.pem
     phish_privkey_pem:
       file: ./src/secrets/phish_privkey.pem
   
   services:
     gophish:
       image: cisagov/gophish:0.0.8
       ports:
         - target: 3333
           published: 3333
           protocol: tcp
           mode: host
         - target: 8080
           published: 3380
           protocol: tcp
           mode: host
       secrets:
         - source: config_json
           target: config.json
         - source: admin_fullchain_pem
           target: admin_fullchain.pem
         - source: admin_privkey_pem
           target: admin_privkey.pem
         - source: phish_fullchain_pem
           target: phish_fullchain.pem
         - source: phish_privkey_pem
           target: phish_privkey.pem

Updating your container

Docker Compose

1. Pull the new image from Docker Hub:

   docker compose pull

2. Recreate the running container by following the previous instructions:

   docker compose up --detach

Docker

1. Stop the running container:

   docker stop <container_id>

2. Pull the new image:

   docker pull cisagov/gophish:0.0.8

3. Recreate and run the container by following the previous instructions.

Image tags

The images of this container are tagged with semantic versions of the underlying gophish project that they containerize. It is recommended that most users use a version tag (e.g. :0.0.8).

Image:tag	Description
cisagov/gophish:0.0.8	An exact release version.
cisagov/gophish:0.0	The most recent release matching the major and minor version numbers.
cisagov/gophish:0	The most recent release matching the major version number.
cisagov/gophish:edge	The most recent image built from a merge into the develop branch of this repository.
cisagov/gophish:nightly	A nightly build of the develop branch of this repository.
cisagov/gophish:latest	The most recent release image pushed to a container registry. Pulling an image using the :latest tag should be avoided.

See the tags tab on Docker Hub for a list of all the supported tags.

Volumes

There are no volumes.

Ports

The following ports are exposed by this container:

Port	Purpose
3333	Admin server
8080	Phishing server

The sample Docker composition publishes the exposed ports at 3333 and 3380, respectively.

Environment variables

Required

There are no required environment variables.

Optional

There are no optional environment variables.

Secrets

Filename	Purpose
config.json	Gophish configuration file
admin_fullchain.pem	public key for admin port
admin_privkey.pem	private key for admin port
phish_fullchain.pem	public key for phishing port
phish_privkey.pem	private key for phishing port

Building from source

Build the image locally using this git repository as the build context:

docker build \
  --build-arg VERSION=0.0.8 \
  --tag cisagov/gophish:0.0.8 \
  https://github.com/cisagov/gophish-docker.git#develop

Cross-platform builds

To create images that are compatible with other platforms, you can use the buildx feature of Docker:

1. Copy the project to your machine using the Code button above or the command line:

   git clone https://github.com/cisagov/gophish-docker.git
   cd gophish-docker

2. Create the Dockerfile-x file with buildx platform support:

   ./buildx-dockerfile.sh

3. Build the image using buildx:

   docker buildx build \
     --file Dockerfile-x \
     --platform linux/amd64 \
     --build-arg VERSION=0.0.8 \
     --output type=docker \
     --tag cisagov/gophish:0.0.8 .

Contributing

We welcome contributions! Please see CONTRIBUTING.md for details.

License

This project is in the worldwide public domain.

This project is in the public domain within the United States, and copyright and related rights in the work worldwide are waived through the CC0 1.0 Universal public domain dedication.

All contributions to this project will be released under the CC0 dedication. By submitting a pull request, you are agreeing to comply with this waiver of copyright interest.