{"id":18781550,"url":"https://github.com/devture/com.devture.ansible.role.traefik_certs_dumper","last_synced_at":"2025-04-13T12:32:45.618Z","repository":{"id":75996754,"uuid":"599118770","full_name":"devture/com.devture.ansible.role.traefik_certs_dumper","owner":"devture","description":"An Ansible role which installs [traefik-certs-dumper](https://github.com/ldez/traefik-certs-dumper) to run as a Docker container wrapped in a systemd service","archived":true,"fork":false,"pushed_at":"2024-09-27T06:42:55.000Z","size":29,"stargazers_count":0,"open_issues_count":1,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-02-19T16:49:55.350Z","etag":null,"topics":["ansible-role","docker","traefik","traefik-certs-dumper"],"latest_commit_sha":null,"homepage":"","language":"Jinja","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/devture.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-02-08T13:48:14.000Z","updated_at":"2024-09-27T06:43:11.000Z","dependencies_parsed_at":"2024-06-04T09:38:57.380Z","dependency_job_id":"6aceaed8-6817-44b0-b4e7-2cffe5f51772","html_url":"https://github.com/devture/com.devture.ansible.role.traefik_certs_dumper","commit_stats":null,"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devture%2Fcom.devture.ansible.role.traefik_certs_dumper","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devture%2Fcom.devture.ansible.role.traefik_certs_dumper/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devture%2Fcom.devture.ansible.role.traefik_certs_dumper/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devture%2Fcom.devture.ansible.role.traefik_certs_dumper/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/devture","download_url":"https://codeload.github.com/devture/com.devture.ansible.role.traefik_certs_dumper/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248714726,"owners_count":21149954,"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","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":["ansible-role","docker","traefik","traefik-certs-dumper"],"created_at":"2024-11-07T20:32:30.284Z","updated_at":"2025-04-13T12:32:45.300Z","avatar_url":"https://github.com/devture.png","language":"Jinja","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Traefik certs dumper Ansible role\n\n⚠️ **WARNING**: this role is now maintained in [mother-of-all-self-hosting/ansible-role-traefik-certs-dumper](https://github.com/mother-of-all-self-hosting/ansible-role-traefik-certs-dumper).\n\nThis is an [Ansible](https://www.ansible.com/) role which installs [traefik-certs-dumper](https://github.com/ldez/traefik-certs-dumper) - a tool which dumps [ACME](https://en.wikipedia.org/wiki/Automatic_Certificate_Management_Environment) certificates (like [Let's Encrypt](https://letsencrypt.org/)) from [Traefik](https://traefik.io/)'s `acme.json` file into some directory. The playbook installs the tool to run as a [Docker](https://www.docker.com/) container wrapped in a systemd service.\n\nThis role *implicitly* depends on [`com.devture.ansible.role.systemd_docker_base`](https://github.com/devture/com.devture.ansible.role.systemd_docker_base).\n\nThis role is related to the [com.devture.ansible.role.traefik](https://github.com/devture/com.devture.ansible.role.traefik) role and integrates nicely with it, but using them both together is **not** a requirement.\n\n## Usage\n\nExample playbook:\n\n```yaml\n- hosts: servers\n  roles:\n    - role: galaxy/com.devture.ansible.role.systemd_docker_base\n\n    # You can also install Traefik in another way and avoid using this role.\n    - role: galaxy/com.devture.ansible.role.traefik\n\n    - role: galaxy/com.devture.ansible.role.traefik_certs_dumper\n\n    - role: another_role\n```\n\nExample playbook configuration (`group_vars/servers` or other):\n\n```yaml\n# Traefik role (com.devture.ansible.role.traefik) configuration here, if you're using it.\n# If not, you can adjust the configuration below to make it work with your own Traefik server.\n\ndevture_traefik_certs_dumper_uid: \"{{ my_uid }}\"\ndevture_traefik_certs_dumper_gid: \"{{ my_gid }}\"\n\ndevture_traefik_certs_dumper_ssl_dir_path: \"{{ devture_traefik_ssl_dir_path }}\"\n```\n\n### systemd\n\n#### devture-traefik-certs-dumper.service\n\nYou can then start the `devture-traefik-certs-dumper.service` systemd service, which watches for a certificate file (`acme.json`, but configurable via `devture_traefik_certs_dumper_ssl_acme_file_name`) in the SSL certificates directory (`devture_traefik_certs_dumper_ssl_dir_path`).\n\nWhen a certificate file appears or whenever it changes in the future, all of its certificates are:\n\n- dumped using [traefik-certs-dumper](https://github.com/ldez/traefik-certs-dumper) to `/devture-traefik-certs-dumper/dumped-certificates` (configurable via `devture_traefik_certs_dumper_dumped_certificates_dir_path`)\n- re-chowned, so that they're owned by `devture_traefik_certs_dumper_dumped_certificates_dir_owner` / `devture_traefik_certs_dumper_dumped_certificates_dir_owner` (defaulting to `devture_traefik_certs_dumper_uid` and `devture_traefik_certs_dumper_gid`, respectively)\n\nThe directory tree would look like this:\n\n```\n/devture-traefik-certs-dumper/dumped-certificates/\n├── example.com\n│   ├── certificate.crt\n│   └── privatekey.key\n├── another.example.com\n│   ├── certificate.crt\n│   └── privatekey.key\n└── private\n    └── letsencrypt.key\n```\n\n#### devture-traefik-certs-dumper-wait-for-domain@.service\n\nTo help you launch other services which depend on these dumped certificate files, this role also provides an [instantiated systemd service](https://www.freedesktop.org/software/systemd/man/systemd.service.html#Service%20Templates) called `devture-traefik-certs-dumper-wait-for-domain@.service`.\n\nYou can adjust your systemd `.service` file definitions to add `Requires` and `After` clauses like this:\n\n```\nRequires=devture-traefik-certs-dumper-wait-for-domain@DOMAIN_NAME.service\nAfter=devture-traefik-certs-dumper-wait-for-domain@DOMAIN_NAME.service\n```\n\nThen, upon launching your service:\n\n- the \"waiter\" service will be started as a dependency\n\n- it will wait for certificates for the specified domain (`DOMAIN_NAME`) to become available (e.g. `/devture-traefik-certs-dumper/dumped-certificates/DOMAIN_NAME/certificate.crt` and `/devture-traefik-certs-dumper/dumped-certificates/DOMAIN_NAME/privatekey.key`)\n\nBy default, the \"waiter\" service waits for 30 seconds (configurable via `devture_traefik_certs_dumper_waiter_max_iterations`) before giving up and aborting execution of your service.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdevture%2Fcom.devture.ansible.role.traefik_certs_dumper","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdevture%2Fcom.devture.ansible.role.traefik_certs_dumper","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdevture%2Fcom.devture.ansible.role.traefik_certs_dumper/lists"}