{"id":16726499,"url":"https://github.com/helgeerbe/certbot-dns-ionos","last_synced_at":"2025-05-16T06:07:34.796Z","repository":{"id":40317708,"uuid":"322715317","full_name":"helgeerbe/certbot-dns-ionos","owner":"helgeerbe","description":"A certbot plugin for enabling DNS authentication with IONOS","archived":false,"fork":false,"pushed_at":"2024-11-09T16:12:59.000Z","size":104,"stargazers_count":48,"open_issues_count":0,"forks_count":11,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-04-08T16:06:18.816Z","etag":null,"topics":["acme-dns","certbot","certbot-dns-plugin","dns","ionos","letsencrypt","plugin"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/helgeerbe.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","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":"2020-12-18T22:09:16.000Z","updated_at":"2025-04-07T15:15:59.000Z","dependencies_parsed_at":"2024-01-08T11:14:06.077Z","dependency_job_id":"b542f5f9-3bff-4259-aff2-7b2c8c7b8aec","html_url":"https://github.com/helgeerbe/certbot-dns-ionos","commit_stats":{"total_commits":44,"total_committers":8,"mean_commits":5.5,"dds":0.5,"last_synced_commit":"9913d7a1a199da5bebe2f39aee734507aee0daa6"},"previous_names":[],"tags_count":16,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/helgeerbe%2Fcertbot-dns-ionos","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/helgeerbe%2Fcertbot-dns-ionos/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/helgeerbe%2Fcertbot-dns-ionos/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/helgeerbe%2Fcertbot-dns-ionos/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/helgeerbe","download_url":"https://codeload.github.com/helgeerbe/certbot-dns-ionos/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254478193,"owners_count":22077676,"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":["acme-dns","certbot","certbot-dns-plugin","dns","ionos","letsencrypt","plugin"],"created_at":"2024-10-12T22:53:22.204Z","updated_at":"2025-05-16T06:07:30.427Z","avatar_url":"https://github.com/helgeerbe.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# certbot-dns-ionos\n\n[IONOS](https://www.ionos.de/) DNS Authenticator plugin for [Certbot](https://certbot.eff.org/)\n\n![Ionos](https://www.ionos.co.uk/newsroom/wp-content/uploads/sites/7/2021/12/LOGO_IONOS_Blue_RGB-1.png)\n\nThis plugin automates the process of completing a ``dns-01`` challenge by\ncreating, and subsequently removing, TXT records using the [IONOS Remote API](https://developer.hosting.ionos.com/docs/dns).\n\n## Configuration of IONOS\n\nIn the `System -\u003e Remote Users` you have to have a user, with the following rights\n\n- Client Functions\n- DNS zone functions\n- DNS txt functions\n\n## Installation\n\n### Snap\n\n[![Get it from the Snap Store](https://snapcraft.io/static/images/badges/en/snap-store-black.svg)](https://snapcraft.io/certbot-dns-ionos)\nSnap version will be compatible with certbot 3.0. Thanks to [DorianCoding](https://github.com/DorianCoding) to make this plugin avalabe in the Snap Store.\n\n### Pip\n\n`pip install certbot-dns-ionos`\n\n## Named Arguments\n\nTo start using DNS authentication for ionos, pass the following arguments on certbot's command line:\n\n| Command args | Command definition |\n| --- | --- |\n|``--authenticator dns-ionos`` | select the authenticator plugin (Required) |\n|``--dns-ionos-credentials`` |ionos Remote User credentials INI file. (Required) |\n|``--dns-ionos-propagation-seconds``|waiting time for DNS to propagate before asking the ACME server to verify the DNS record. (Default: 10, Recommended: 60) |\n\n## Credentials\n\nAn example ``credentials.ini`` file:\n\n```ini\ndns_ionos_prefix = myapikeyprefix\ndns_ionos_secret = verysecureapikeysecret\ndns_ionos_endpoint = https://api.hosting.ionos.com\n```\n\nThe key can be managed under the following link:  \u003chttps://developer.hosting.ionos.de/?source=IonosControlPanel\u003e\n\nThe path to this file can be provided interactively or using the\n`--dns-ionos-credentials` command-line argument. Certbot\nrecords the path to this file for use during renewal, but does not store the file's contents.\n\n\u003e [!CAUTION]\n\u003e You should protect these API credentials as you would the\npassword to your ionos account. Users who can read this file can use these credentials to issue arbitrary API calls\non your behalf. Users who can cause Certbot to run using these credentials can complete a ``dns-01`` challenge\nto acquire new certificates or revoke existing certificates for associated domains, even if those domains aren't\nbeing managed by this server.\n\n\u003e [!WARNING]\n\u003e Certbot will emit a warning if it detects that the credentials file can be accessed by other users on your system.\nThe warning reads \"Unsafe permissions on credentials configuration file\", followed by the path to the\ncredentials file. This warning will be emitted each time Certbot uses the credentials file, including for renewal,\nand cannot be silenced except by addressing the issue (e.g., by using a command like ``chmod 600`` to \nrestrict access to the file and ``chmod 700`` to restrict access to the folder).\n\n## Examples\n\nTo acquire a single certificate for both ``example.com`` and\n``*.example.com``, waiting 900 seconds for DNS propagation:\n\n```bash\ncertbot certonly \\\n--authenticator dns-ionos \\\n--dns-ionos-credentials /etc/letsencrypt/.secrets/domain.tld.ini \\\n--dns-ionos-propagation-seconds 900 \\\n--server https://acme-v02.api.letsencrypt.org/directory \\\n--agree-tos \\\n--rsa-key-size 4096 \\\n-d 'example.com' \\\n-d '*.example.com'\n```\n\n## Docker\n\nIn order to create a docker container with a certbot-dns-ionos installation,\ncreate an empty directory with the following ``Dockerfile``:\n\n```docker\nFROM certbot/certbot\nRUN pip install certbot-dns-ionos\n```\n\nProceed to build the image\n\n```docker\ndocker build -t certbot/dns-ionos .\n```\n\nOnce that's finished, the application can be run as follows::\n\n```docker\ndocker run --rm \\\n-v /var/lib/letsencrypt:/var/lib/letsencrypt \\\n-v /etc/letsencrypt:/etc/letsencrypt \\\n--cap-drop=all \\\ncertbot/dns-ionos certonly \\\n--authenticator dns-ionos \\\n--dns-ionos-propagation-seconds 900 \\\n--dns-ionos-credentials \\\n/etc/letsencrypt/.secrets/domain.tld.ini \\\n--no-self-upgrade \\\n--keep-until-expiring --non-interactive --expand \\\n--server https://acme-v02.api.letsencrypt.org/directory \\\n-d example.com -d '*.example.com'\n```\n\nIt is suggested to secure the folder as follows\n\n```bash\nchown root:root /etc/letsencrypt/.secrets\nchmod 700 /etc/letsencrypt/.secrets\n```\n\nThe file 'domain.tld.ini' must be replaced with the version of the example 'credentials.ini' adapted to your provider.\n\n## Changelog\n\n- 2024.11.09\n  - Update for Certbot 3.0.0\n- 2024.10.20\n  - fix: set long_description_content_type to text/markdown.\n    This error breaks the upload to pypi\n- 2024.10.19\n  - Update for Certbot 2.11.0\n  - Update README.md, changed from README.rst\n  - Addition of a snap\n  - Correction in case of API error\n- 2024.01.08\n  - Update README.rst\n  - Add Link to IONOS control panel and reference between credentials.ini and domain.tld.ini\n- 2023.11.13\n  - Fix managed zone lookup to ensure correct domain is selected where there are two domains with the same ending e.g. example.com and thisisanexample.com (PR #22)\n- 2022.11.24\n  - Remove zope to fix compatibility with Certbot 2.x (Fixes #19)\n  - As a reminder, Certbot will default to issuing ECDSA certificates from release 2.0.0.\n  - If you update from a prior certbot release, run the plugin once manually. You will be prompted to update RSA key type to ECDSA.\n- 2022.05.15\n  - Added capability to handle multiple domain validations #16\n- 2021.09.20.post1\n  - Fix version number\n- 2021.09.20\n  - Fix #9 Domain not known when using subdomain\n\n## Related Plugins\n\nIt's important to note that this plugin targets [IONOS Developer DNS API](https://developer.hosting.ionos.com/docs/dns\u003e).\nIf you are using IONOS [Cloud DNS service](https://cloud.ionos.com/network/cloud-dns\u003e),\nthere is a different plugin provided by IONOS: \u003chttps://github.com/ionos-cloud/certbot-dns-ionos-cloud\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhelgeerbe%2Fcertbot-dns-ionos","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhelgeerbe%2Fcertbot-dns-ionos","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhelgeerbe%2Fcertbot-dns-ionos/lists"}