cisagov/admiral repository overview

⁠admiral-docker 💀🐳

⁠Docker Image

This Docker project serves as the vessel for certificate transparency scanning performed by the admiral Python library⁠.

⁠Running

⁠Running with Docker Compose

1. Change the credentials in secrets

2. Choose configuration options for admiral.yml

3. Start the container and detach:

   docker compose up --detach
   

   Copy

⁠Monitoring

The following web services are started for monitoring the underlying components:

• Celery Flower: http://localhost:5555⁠
• Mongo Express: http://localhost:8083⁠
• Redis Commander: http://localhost:8082⁠

⁠Using secrets

This composition passes credentials and configuration options via Docker secrets⁠. You need to modify the files listed in the secrets⁠ section below. To prevent yourself from inadvertently committing sensitive values to the repository, run git update-index --assume-unchanged src/secrets/*.

⁠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

⁠Updating Python dependencies

This image uses [Pipenv] to manage Python dependencies using a Pipfile⁠. Both updating dependencies and changing the [Pipenv] configuration in src/Pipfile will result in a modified src/Pipfile.lock file that should be committed to the repository.

⁠Updating dependencies

If you want to update existing dependencies you would run the following command in the src/ subdirectory:

pipenv lock

⁠Modifying dependencies

If you want to add or remove dependencies you would update the src/Pipfile file and then update dependencies as you would above.

⁠Image tags

The images of this container are tagged with semantic versions⁠ of the admiral⁠ Python library that they containerize. It is recommended that most users use a version tag (e.g. :3.0.0).

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

⁠Volumes

⁠Ports

The following ports are exposed by this container:

⁠Environment variables

⁠Required

There are no required environment variables.

⁠Optional

⁠Secrets

⁠Building from source

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

docker build \
  --build-arg VERSION=3.0.0 \
  --tag cisagov/admiral:3.0.0 \
  https://github.com/cisagov/admiral-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/admiral-docker.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=3.0.0 \
     --output type=docker \
     --tag cisagov/admiral:3.0.0 .
   

   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.