{"id":14065151,"url":"https://github.com/aaomidi/certbot-dns-google-domains","last_synced_at":"2025-07-17T03:32:32.266Z","repository":{"id":80615043,"uuid":"560125060","full_name":"aaomidi/certbot-dns-google-domains","owner":"aaomidi","description":"Google Domains plugin for Certbot.","archived":false,"fork":false,"pushed_at":"2023-08-02T01:34:01.000Z","size":180,"stargazers_count":71,"open_issues_count":6,"forks_count":11,"subscribers_count":7,"default_branch":"main","last_synced_at":"2025-07-15T05:22:37.123Z","etag":null,"topics":["certbot","dns","google-domains"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/aaomidi.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}},"created_at":"2022-10-31T19:39:54.000Z","updated_at":"2025-05-10T11:17:07.000Z","dependencies_parsed_at":"2024-02-15T00:50:15.989Z","dependency_job_id":null,"html_url":"https://github.com/aaomidi/certbot-dns-google-domains","commit_stats":null,"previous_names":[],"tags_count":10,"template":false,"template_full_name":null,"purl":"pkg:github/aaomidi/certbot-dns-google-domains","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aaomidi%2Fcertbot-dns-google-domains","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aaomidi%2Fcertbot-dns-google-domains/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aaomidi%2Fcertbot-dns-google-domains/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aaomidi%2Fcertbot-dns-google-domains/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/aaomidi","download_url":"https://codeload.github.com/aaomidi/certbot-dns-google-domains/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aaomidi%2Fcertbot-dns-google-domains/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":265563028,"owners_count":23788632,"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":["certbot","dns","google-domains"],"created_at":"2024-08-13T07:04:19.978Z","updated_at":"2025-07-17T03:32:32.219Z","avatar_url":"https://github.com/aaomidi.png","language":"Python","funding_links":[],"categories":["Python"],"sub_categories":[],"readme":"# certbot-dns-google-domains\n\nA Certbot DNS Authenticator for [Google Domains](https://domains.google/).\n\n## Named Arguments\n\nOption|Description\n---|---|\n`--authenticator dns-google-domains`|Select this authenticator plugin.\n`--dns-google-domains-credentials FILE`|Path to the INI file with credentials.\n`--dns-google-domains-propagation-seconds INT`|How long to wait for DNS changes to propagate. Default = 30s.\n`--dns-google-domains-zone STRING`|What the registered domain on Google domains is. Default: Retrieved from either the credentials file, or by using the public suffix list to guess.\n\n## Credentials\n\nThe credentials file includes the access token for Google Domains.\n\n```.ini\ndns_google_domains_access_token = abcdef\n```\n\nOptionally, you can also define the zone in this file.\n\n```.ini\ndns_google_domains_access_token = abcdef\ndns_google_domains_zone = example.com\n```\n\n## Usage Example\n\n### Docker / Podman\n\n``` bash\ndocker run \\\n  -v '/var/lib/letsencrypt:/var/lib/letsencrypt' \\\n  -v '/etc/letsencrypt:/etc/letsencrypt' \\\n  --cap-drop=all \\\n  ghcr.io/aaomidi/certbot-dns-google-domains:latest \\\n  certbot certonly \\\n  --authenticator 'dns-google-domains' \\\n  --dns-google-domains-credentials '/var/lib/letsencrypt/dns_google_domains_credentials.ini' \\\n  --server 'https://acme-v02.api.letsencrypt.org/directory' \\\n  --non-interactive \\\n  --dns-google-domains-zone 'example.com' \\\n  -d 'a.example.com'\n```\n\nNotes:\n- `-v '/var/lib/letsencrypt:/var/lib/letsencrypt'` is where certbot by default outputs certificates, keys, and account information.\n- `-v '/etc/letsencrypt:/etc/letsencrypt'` is where certbot keeps its configuration.\n- `--authenticator 'dns-google-domains'` uses the dns-google-domains authenticator.\n- `--dns-google-domains-credentials '/var/lib/letsencrypt/dns_google_domains_credentials.ini'` is the path to the credentials file.\n- `--dns-google-domains-zone 'example.com'` is the main domain you have registered with Google domains. This is optional.\n- To ensure successful execution, this command requires you to intentionally provide both the --email and --agree-tos arguments. The command does not include them by default, as it is important for users to consciously agree to the terms of service and supply their email address.\n\n### Python\n\nYou can get the `certbot-dns-google-domains` package from [PyPi](https://pypi.org/project/certbot-dns-google-domains/):\n\n```bash\npip3 install certbot certbot-dns-google-domains\n\ncertbot certonly \\\n--authenticator 'dns-google-domains' \\\n--dns-google-domains-credentials '/var/lib/letsencrypt/dns_google_domains_credentials.ini' \\\n--server 'https://acme-v02.api.letsencrypt.org/directory' \\\n--dns-google-domains-zone 'example.com' \\\n-d 'a.example.com'\n```\n\nNote: If you have installed Certbot from a non-pip3 source, the certbot-dns-google-domains plugin might not be compatible with your existing Certbot installation. In this case, consider using pip3 to install Certbot and its plugins to ensure compatibility.\n\n### Homebrew\n\n```bash\nbrew install certbot\n$(brew --prefix certbot)/libexec/bin/pip3 install certbot-dns-google-domains\n```\n\n## Notes on Zone Resolution\n\nGoogle Domains does not provide an API to obtain the zone for a domain based on a subdomain. This plugin employs the following logic to determine the zone:\n\n1. If the `--dns-google-domains-zone` argument is specified, use that.\n2. If the credentials file specifies a zone, use that.\n3. Utilize the [Public Suffix List](https://publicsuffix.org/) to determine the zone.\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faaomidi%2Fcertbot-dns-google-domains","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Faaomidi%2Fcertbot-dns-google-domains","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faaomidi%2Fcertbot-dns-google-domains/lists"}