cisagov/pca-report-library repository overview

⁠pca-report-generator-docker

⁠Docker Image

This is a Docker project that containerizes the pca-report-library⁠ package, which can be used to generate Phishing Campaign Assessment (PCA) reports.

⁠Running

The following Docker commands are available.

An alias can also be set beforehand to remove redundancy.

pca-report-generator - Creates a PCA report as a PDF

docker run -v $(pwd):/home/cisa cisagov/pca-report-generator pca-report-generator

pca-report-templates - Exports the Report Mustache template and Manual data file template

docker run -v $(pwd):/home/cisa cisagov/pca-report-generator pca-report-templates

pca-report-compiler - Compiles a PCA LaTeX report file, still in development.

docker run -v $(pwd):/home/cisa cisagov/pca-report-generator pca-report-compiler

pca-report-generator-bash - Starts up a bash shell in the container

docker run -v $(pwd):/home/cisa cisagov/pca-report-generator pca-report-generator-bash

⁠Running with Docker Compose

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

   ---
   version: "3.7"
   
   services:
     pca-report-library:
       image: cisagov/pca-report-library:0.0.1
       volumes:
         - type: bind
           source: <your_log_dir>
           target: /home/cisa
   

   Copy

2. Start the container and detach:

   docker-compose up --detach
   

   Copy

⁠Updating your container

⁠Docker Compose

1. Pull the new image from Docker Hub:

   docker-compose pull
   

   Copy

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

   docker-compose up --detach
   

   Copy

⁠Docker

1. Stop the running container:

   docker stop <container_id>
   

   Copy

2. Pull the new image:

   docker pull cisagov/pca-report-library:0.0.1
   

   Copy

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 example project that they containerize. It is recommended that most users use a version tag (e.g. :0.0.1).

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

⁠Volumes

There are no volumes for this container.

⁠Ports

There are no ports exposed by this container.

⁠Environment variables

⁠Optional

⁠Secrets

There are no secrets for this container.

⁠Building from source

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

docker build \
  --build-arg VERSION=0.0.1 \
  --tag cisagov/pca-report-library:0.0.1 \
  https://github.com/cisagov/pca-report-library.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/pca-report-library.git
   cd example
   

   Copy

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

   ./buildx-dockerfile.sh
   

   Copy

3. Build the image using buildx:

   docker buildx build \
     --file Dockerfile-x \
     --platform linux/amd64 \
     --build-arg VERSION=0.0.1 \
     --output type=docker \
     --tag cisagov/pca-report-library:0.0.1 .
   

   Copy

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