search

home-assistant / addons

:heavy_plus_sign: Docker add-ons for Home Assistant
https://home-assistant.io/hassio/
Apache License 2.0
1.57k stars 1.52k forks source link

letsencrypt: Drop Google Domains support #3750

Closed agners closed 2 months ago

agners commented 2 months ago

Google Domains is no longer operational, all domains have been transferred to Squarespace. Squarespace does not support ACME. Drop Google Domains support for the Let's Encrypt add-on.

Summary by CodeRabbit

coderabbitai[bot] commented 2 months ago
Walkthrough ## Walkthrough The changes involve the removal of support for Google Domains in the Let's Encrypt project due to the transition to Squarespace, which lacks ACME support. This includes the elimination of related configuration parameters, dependencies, and documentation. The version has been updated to 5.1.4, reflecting these modifications. Users relying on Google Domains for DNS management will need to adjust their configurations accordingly. ## Changes | File | Change Summary | |-------------------------------------------|----------------------------------------------------------------------------------------------------| | `letsencrypt/CHANGELOG.md` | Updated to version 5.1.4; noted removal of Google Domains support. | | `letsencrypt/DOCS.md` | Removed `google_domains_access_token` and `google_domains_zone` parameters from documentation. | | `letsencrypt/Dockerfile` | Removed `certbot-dns-google-domains` package from dependencies. | | `letsencrypt/build.yaml` | Removed `CERTBOT_DNS_GOOGLE_DOMAINS_VERSION` from build configuration. | | `letsencrypt/config.yaml` | Updated version to 5.1.4; removed Google Domains related fields and references. | | `letsencrypt/rootfs/etc/cont-init.d/file-structure.sh` | Removed echoing of Google Domains configurations; introduced structured handling of options. | | `letsencrypt/rootfs/etc/services.d/lets-encrypt/run` | Removed logic related to Google Domains from DNS challenge handling script. |
Recent review details **Configuration used: CodeRabbit UI** **Review profile: CHILL**
Commits Files that changed from the base of the PR and between 5b8fa76fa32fa717d29ecbfde7ac0daa892f9c0d and 17898b96b643384832729f35aa30c3e26248b7a4.
Files selected for processing (7) * letsencrypt/CHANGELOG.md (1 hunks) * letsencrypt/DOCS.md (2 hunks) * letsencrypt/Dockerfile (2 hunks) * letsencrypt/build.yaml (1 hunks) * letsencrypt/config.yaml (3 hunks) * letsencrypt/rootfs/etc/cont-init.d/file-structure.sh (3 hunks) * letsencrypt/rootfs/etc/services.d/lets-encrypt/run (1 hunks)
Files skipped from review due to trivial changes (1) * letsencrypt/build.yaml
Files skipped from review as they are similar to previous changes (5) * letsencrypt/CHANGELOG.md * letsencrypt/Dockerfile * letsencrypt/config.yaml * letsencrypt/rootfs/etc/cont-init.d/file-structure.sh * letsencrypt/rootfs/etc/services.d/lets-encrypt/run
Additional context used
Path-based instructions (1)
letsencrypt/DOCS.md (6) Pattern `*/**(html|markdown|md)`: - For instructional content in documentation, use a direct and authoritative tone. Avoid expressions of politeness such as 'may' or 'please', and ensure the goal of the instruction is fronted. - Apply the Microsoft Style Guide to ensure documentation maintains clarity and conciseness. - In step-by-step instructions, front the location phrase in the instructional sentence. - In step-by-step instructions, front the 'goal' in the instructional sentence. - In step-by-step instructions, if in doubt what to front, front the 'goal' before the location phrase in the instructional sentence. - do not hyphenate terms like 'top-right' or 'bottom-left' with 'corner' --- Pattern `*/**(html|markdown|md)`: - Use bold to mark UI strings. - If "" are used to mark UI strings, replace them by bold. --- Pattern `*/**(html|markdown|md)`: - Be brief in your replies and don't add fluff like "thank you for..." and "Please let me know if" --- Pattern `*/**(html|markdown|md)`: - Use sentence-style capitalization also in headings. --- Pattern `*/**(html|markdown|md)`: do not comment on HTML used for icons --- Pattern `*/**(html|markdown|md)`: Avoid flagging inline HTML for embedding videos in future reviews for this repository.
Additional comments not posted (10)
letsencrypt/DOCS.md (10)
Line range hint `1-1`: **Documentation header is clear and concise.** The title clearly identifies the document as pertaining to the Home Assistant Add-on for Letsencrypt, which is appropriate for the context. --- Line range hint `3-11`: **Installation instructions are clear and correctly formatted.** The step-by-step instructions for installing the add-on are clear and use direct language, which is good practice for technical documentation. --- Line range hint `13-31`: **Usage instructions are comprehensive and well-structured.** The instructions on how to use the Letsencrypt add-on, including navigating through the Home Assistant interface and configuring the add-on, are detailed and easy to follow. --- Line range hint `33-35`: **HTTP challenge section is accurate.** This section correctly describes the requirements and limitations of using the HTTP challenge for certificate issuance. --- Line range hint `43-43`: **Configuration fields section is detailed and well-explained.** This section provides a comprehensive list of fields required by different DNS providers, which is useful for users configuring the DNS challenge. --- Line range hint `45-45`: **Certificate files section is informative and clear.** This section effectively explains how to locate and use the certificate files generated by the add-on. --- Line range hint `47-47`: **Certificate creation and renewal process is well-documented.** The explanation of how certificates are created and renewed, including automation options, is thorough and provides good guidance for users. --- Line range hint `49-49`: **Advanced configuration options are well-detailed.** The sections on changing the ACME server, selecting the key type, and setting up external account binding provide advanced users with the necessary configurations to customize their setup. --- Line range hint `51-51`: **Example configurations are helpful and relevant.** The YAML configuration examples for different challenges and DNS providers are practical and enhance the usability of the documentation. --- Line range hint `53-53`: **Support section provides multiple avenues for user assistance.** The inclusion of links to community resources and support channels is beneficial for users seeking help.
--- Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?
Share - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (Invoked using PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. ### Other keywords and placeholders - Add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. - Add `@coderabbitai summary` to generate the high-level summary at a specific location in the PR description. - Add `@coderabbitai` or `@coderabbitai title` anywhere in the PR title to generate the title automatically. ### CodeRabbit Configuration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.