{"id":31955867,"url":"https://github.com/cisagov/admiral-docker","last_synced_at":"2025-10-14T14:32:20.989Z","repository":{"id":89767215,"uuid":"595638076","full_name":"cisagov/admiral-docker","owner":"cisagov","description":"Docker components for the Dreaded Rear Admiral","archived":false,"fork":false,"pushed_at":"2025-10-06T21:29:24.000Z","size":1074,"stargazers_count":5,"open_issues_count":7,"forks_count":2,"subscribers_count":3,"default_branch":"develop","last_synced_at":"2025-10-06T23:26:20.516Z","etag":null,"topics":["certificate-transparency","docker"],"latest_commit_sha":null,"homepage":"","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"cc0-1.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/cisagov.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2023-01-31T14:01:38.000Z","updated_at":"2025-04-04T03:54:05.000Z","dependencies_parsed_at":"2025-01-12T12:18:31.546Z","dependency_job_id":"3303869c-6efc-4502-aa36-95f14af6b1c2","html_url":"https://github.com/cisagov/admiral-docker","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/cisagov/admiral-docker","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cisagov%2Fadmiral-docker","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cisagov%2Fadmiral-docker/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cisagov%2Fadmiral-docker/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cisagov%2Fadmiral-docker/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cisagov","download_url":"https://codeload.github.com/cisagov/admiral-docker/tar.gz/refs/heads/develop","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cisagov%2Fadmiral-docker/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279019126,"owners_count":26086680,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-14T02:00:06.444Z","response_time":60,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["certificate-transparency","docker"],"created_at":"2025-10-14T14:30:37.218Z","updated_at":"2025-10-14T14:32:20.979Z","avatar_url":"https://github.com/cisagov.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# admiral-docker 💀🐳 #\n\n[![GitHub Build Status](https://github.com/cisagov/admiral-docker/workflows/build/badge.svg)](https://github.com/cisagov/admiral-docker/actions/workflows/build.yml)\n[![CodeQL](https://github.com/cisagov/admiral-docker/workflows/CodeQL/badge.svg)](https://github.com/cisagov/admiral-docker/actions/workflows/codeql-analysis.yml)\n[![Known Vulnerabilities](https://snyk.io/test/github/cisagov/admiral-docker/badge.svg)](https://snyk.io/test/github/cisagov/admiral-docker)\n\n## Docker Image ##\n\n[![Docker Pulls](https://img.shields.io/docker/pulls/cisagov/admiral)](https://hub.docker.com/r/cisagov/admiral)\n[![Docker Image Size (latest by date)](https://img.shields.io/docker/image-size/cisagov/admiral)](https://hub.docker.com/r/cisagov/admiral)\n[![Platforms](https://img.shields.io/badge/platforms-amd64%20%7C%20arm%2Fv6%20%7C%20arm%2Fv7%20%7C%20arm64%20%7C%20ppc64le%20%7C%20s390x-blue)](https://hub.docker.com/r/cisagov/admiral-docker/tags)\n\nThis Docker project serves as the vessel for certificate transparency\nscanning performed by the [admiral Python library](https://github.com/cisagov/admiral).\n\n## Running ##\n\n### Running with Docker Compose ###\n\n1. Change the credentials in `secrets`\n1. Choose configuration options for `admiral.yml`\n1. Start the container and detach:\n\n    ```console\n    docker compose up --detach\n    ```\n\n## Monitoring ##\n\nThe following web services are started for monitoring the underlying components:\n\n- Celery Flower: [http://localhost:5555](http://localhost:5555)\n- Mongo Express: [http://localhost:8083](http://localhost:8083)\n- Redis Commander: [http://localhost:8082](http://localhost:8082)\n\n## Using secrets ##\n\nThis composistion passes credentials and configuration options via [Docker\nsecrets](https://docs.docker.com/engine/swarm/secrets/). You need to modify\nthe files listed in the [secrets](#secrets) section below. To prevent yourself\nfrom inadvertently committing sensitive values to the repository, run\n`git update-index --assume-unchanged src/secrets/*`.\n\n## Updating your container ##\n\n### Docker Compose ###\n\n1. Pull the new image from Docker Hub:\n\n    ```console\n    docker compose pull\n    ```\n\n1. Recreate the running container by following the [previous instructions](#running-with-docker-compose):\n\n    ```console\n    docker compose up --detach\n    ```\n\n## Image tags ##\n\nThe images of this container are tagged with [semantic\nversions](https://semver.org) of the [admiral](https://github.com/cisagov/admiral)\nPython library that they containerize.  It is recommended that most users\nuse a version tag (e.g. `:1.4.0`).\n\n| Image:tag | Description |\n|-----------|-------------|\n|`cisagov/admiral:1.4.0`| An exact release version. |\n|`cisagov/admiral:1.3`| The most recent release matching the major and minor version numbers. |\n|`cisagov/admiral:1`| The most recent release matching the major version number. |\n|`cisagov/admiral:edge` | The most recent image built from a merge into the `develop` branch of this repository. |\n|`cisagov/admiral:nightly` | A nightly build of the `develop` branch of this repository. |\n|`cisagov/admiral:latest`| The most recent release image pushed to a container registry.  Pulling an image using the `:latest` tag [should be avoided.](https://vsupalov.com/docker-latest-tag/) |\n\nSee the [tags tab](https://hub.docker.com/r/cisagov/admiral/tags) on Docker\nHub for a list of all the supported tags.\n\n## Volumes ##\n\n| Mount point | Purpose        |\n|-------------|----------------|\n| `mongo-init.js`  |  Stores the initialization script for MongoDB   |\n\n## Ports ##\n\nThe following ports are exposed by this container:\n\n| Port | Purpose        |\n|------|----------------|\n| 5555 | Celery Flower |\n| 6379 | Redis |\n| 8081 | Redis Commander |\n| 8083 | Mongo Express |\n\n## Environment variables ##\n\n### Required ###\n\nThere are no required environment variables.\n\n\u003c!--\n| Name  | Purpose | Default |\n|-------|---------|---------|\n| `REQUIRED_VARIABLE` | Describe its purpose. | `null` |\n--\u003e\n\n### Optional ###\n\n| Name  | Purpose | Default |\n|-------|---------|---------|\n| `ADMIRAL_CONFIG_FILE` | Celery configuration | `admiral.yml` |\n| `ADMIRAL_CONFIG_SECTION` | Configuration section to use  | `dev-mode` |\n| `ADMIRAL_WORKER_NAME` | Worker names | `dev` |\n| `CISA_HOME` | Home folder | `/home/cisa` |\n| `CISA_GROUP` | Group identifier | `cisa` |\n\n## Secrets ##\n\n| Filename     | Purpose |\n|--------------|---------|\n| `admiral.yml` | Celery configuration |\n| `mongo.yml` | MongoDB configuration |\n| `mongo-root-passwd.txt` | MongoDB root password |\n| `redis.conf` | Redis configuration |\n| `sslmate-api-key.txt` | API key for SSLMate's Certificate Transparency Search API |\n\n## Building from source ##\n\nBuild the image locally using this git repository as the [build context](https://docs.docker.com/engine/reference/commandline/build/#git-repositories):\n\n```console\ndocker build \\\n  --build-arg VERSION=0.0.1 \\\n  --tag cisagov/admiral:1.4.0 \\\n  https://github.com/cisagov/admiral-docker.git#develop\n```\n\n## Cross-platform builds ##\n\nTo create images that are compatible with other platforms, you can use the\n[`buildx`](https://docs.docker.com/buildx/working-with-buildx/) feature of\nDocker:\n\n1. Copy the project to your machine using the `Code` button above\n   or the command line:\n\n    ```console\n    git clone https://github.com/cisagov/admiral-docker.git\n    cd example\n    ```\n\n1. Create the `Dockerfile-x` file with `buildx` platform support:\n\n    ```console\n    ./buildx-dockerfile.sh\n    ```\n\n1. Build the image using `buildx`:\n\n    ```console\n    docker buildx build \\\n      --file Dockerfile-x \\\n      --platform linux/amd64 \\\n      --build-arg VERSION=0.0.1 \\\n      --output type=docker \\\n      --tag cisagov/admiral:1.4.0 .\n    ```\n\n## Contributing ##\n\nWe welcome contributions!  Please see [`CONTRIBUTING.md`](CONTRIBUTING.md) for\ndetails.\n\n## License ##\n\nThis project is in the worldwide [public domain](LICENSE).\n\nThis project is in the public domain within the United States, and\ncopyright and related rights in the work worldwide are waived through\nthe [CC0 1.0 Universal public domain\ndedication](https://creativecommons.org/publicdomain/zero/1.0/).\n\nAll contributions to this project will be released under the CC0\ndedication. By submitting a pull request, you are agreeing to comply\nwith this waiver of copyright interest.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcisagov%2Fadmiral-docker","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcisagov%2Fadmiral-docker","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcisagov%2Fadmiral-docker/lists"}