upstream/certbot
1
0
Fork 0
mirror of https://github.com/certbot/certbot.git synced 2026-02-03 20:40:36 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions 1
certbot/tools/docker
History
Yaroslav Halchenko 86f76cd3df
Add codespell support (CI to check, not to fix) and make it fix a few typos (#10297) 
Another token of gratitude for a super useful tool and service.

More about codespell: https://github.com/codespell-project/codespell .

I personally introduced it to dozens if not hundreds of projects already
and so far only positive feedback.

CI workflow has 'permissions' set only to 'read' so also should be safe.

---------

Signed-off-by: Yaroslav O. Halchenko <debian@onerussian.com>
2025-06-24 13:14:31 +09:00
..
lib Add codespell support (CI to check, not to fix) and make it fix a few typos (#10297) 2025-06-24 13:14:31 +09:00
build.sh Build with buildkit (#9628) 2023-04-08 12:22:16 -07:00
deploy_images.sh Build with buildkit (#9628) 2023-04-08 12:22:16 -07:00
deploy_manifests.sh Build with buildkit (#9628) 2023-04-08 12:22:16 -07:00
Dockerfile update docker image (#10057) 2024-11-14 13:37:08 -08:00
README.md Escape <TAG> in docker readme file (#10235) 2025-03-17 08:48:25 -07:00
test.sh Build with buildkit (#9628) 2023-04-08 12:22:16 -07:00

README.md

Running Certbot in Docker

Docker is an amazingly simple and quick way to obtain a certificate. However, this mode of operation is unable to install certificates automatically or configure your webserver, because our installer plugins cannot reach your webserver from inside the Docker container.

Most users should install Certbot by following the installation instructions at https://certbot.eff.org/instructions. You should only use Docker if you are sure you know what you are doing (you understand volumes) and have a good reason to do so, such as following the one service per container rule.

For more information, please read Certbot - Running with Docker.

Certbot Docker Tools

Goal

This code is used to build and deploy new versions of the Certbot and Certbot DNS plugin Docker images to Docker Hub.

High-level behavior

Running ./build.sh <TAG> all causes the Docker images to be built for all supported architectures. The generated images are stored in the local docker image cache.

Running ./test.sh <TAG> all loads images from the docker image cache and runs a test command to validate the image contents.

Running ./deploy_images.sh <TAG> all will push the previously generated images to Docker Hub. The <TAG> argument is an identifier applied to all docker images and manifests. It may be something like nightly or v2.3.2. If the tag is a version stamp greater than v2.0.0, then a latest tag will also be generated and pushed to the docker hub repo.

Running ./deploy_manifests.sh <TAG> all will add multiarch manifests to Docker Hub. This command assumes that ./deploy_images.sh <TAG> all has been previously run with the same tag.

Configuration

To run these scripts you need:

  1. A computer with Docker installed and the Docker daemon running. You probably don't want to use the docker snap as these scripts have failed when using that in the past.
  2. To be logged into Docker Hub with an account able to push to the Certbot and Certbot DNS Docker images on Docker Hub. Altering the value of DOCKER_HUB_ORG in lib/common will allow you to push to your own account for testing.