Required for install:

This is a Docker skeleton project that can be used to quickly get a new cisagov GitHub Docker project started. This skeleton project contains licensing information, as well as pre-commit hooks and GitHub Actions configurations appropriate for Docker containers and the major languages that we use.

To run the cisagov/con-pca-api image via Docker:

docker run cisagov/con-pca-api:0.0.1

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

   ---
   version: "3.8"
   
   services:
     api:
       image: cisagov/con-pca-api:0.0.1
       volumes:
         - type: bind
           source: <your_log_dir>
           target: /var/log
       environment:
         - ECHO_MESSAGE="Hello from docker compose"
       ports:
         - target: 8080
           published: 8080
           protocol: tcp

2. Start the container and detach:

   docker compose up --detach

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 quote.txt file containing the values you want set:

   Better lock it in your pocket.
   

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

   ---
   version: "3.7"
   
   secrets:
     quote_txt:
       file: quote.txt
   
   services:
     api:
       image: cisagov/con-pca-api:0.0.1
       volumes:
         - type: bind
           source: <your_log_dir>
           target: /var/log
       environment:
         - ECHO_MESSAGE="Hello from docker compose"
       ports:
         - target: 8080
           published: 8080
           protocol: tcp
       secrets:
         - source: quote_txt
           target: quote.txt

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

1. Stop the running container:

   docker stop <container_id>

2. Pull the new image:

   docker pull cisagov/con-pca-api:0.0.1

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

The images of this container are tagged with semantic versions of the underlying con-pca-api 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.

git clone git@github.com:cisagov/con-pca-api.git
cd con-pca-api/

The following ports are exposed by this container:

The Docker composition publishes the exposed ports at 5000 and 8000.

All environment defaults can be found in the default environment file. Once copied to the base directory as .env, they will automatically be included in docker-compose.

There are no required environment variables.

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

docker build \
  --build-arg VERSION=0.0.1 \
  --tag cisagov/con-pca-api:0.0.1 \
  https://github.com/cisagov/con-pca-api.git#develop

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/con-pca-api.git
   cd con-pca-api

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.1 \
     --output type=docker \
     --tag cisagov/con-pca-api:0.0.1 .