addons icon indicating copy to clipboard operation
addons copied to clipboard

add support for mijn.host DNS challenge

Open shubhamku044 opened this issue 1 year ago • 12 comments

Summary by CodeRabbit

  • New Features

    • Added support for the "mijn.host" DNS service, enhancing DNS challenge configuration options.
    • Introduced a new optional field for the Mijn Host API key in the configuration.
  • Bug Fixes

    • Improved configuration handling for the new DNS provider to ensure proper API key integration.
  • Documentation

    • Expanded the changelog to include version updates and support details for "mijn.host".
  • Chores

    • Updated configuration files to support the new DNS provider functionality.

shubhamku044 avatar Sep 05 '24 06:09 shubhamku044

Please take a look at the requested changes, and use the Ready for review button when you are done, thanks :+1:

Learn more about our pull request process.

home-assistant[bot] avatar Sep 05 '24 06:09 home-assistant[bot]

Add support for mijn.host dns challenge

shubhamku044 avatar Sep 05 '24 06:09 shubhamku044

[!WARNING]

Rate limit exceeded

@agners has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 3 minutes and 36 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between ea54b9b45c2395eb9704537ec9cf02ef91659435 and 58ed2aadac78bbb204c3a44c3e0f58c79ac56900.

📝 Walkthrough
📝 Walkthrough
📝 Walkthrough
📝 Walkthrough
📝 Walkthrough
📝 Walkthrough

Walkthrough

The changes include the addition of support for the "mijn.host" DNS service in the Let's Encrypt project. This update encompasses modifications across multiple files, including the changelog, documentation, Dockerfile, build configuration, and settings files. The updates introduce new variables, configuration options, and instructions to facilitate the integration of the new DNS provider, enhancing the overall functionality of the system.

Changes

Files Change Summary
letsencrypt/CHANGELOG.md Updated to include version 5.2.4 with support for "mijn.host" DNS service.
letsencrypt/DOCS.md Added "mijn.host" to the list of supported DNS providers and included an example configuration for DNS challenge.
letsencrypt/Dockerfile Added argument CERTBOT_DNS_MIJN_HOST_VERSION and installation of certbot-dns-mijn-host.
letsencrypt/build.yaml Introduced CERTBOT_DNS_MIJN_HOST_VERSION: 0.0.5 for the new DNS provider.
letsencrypt/config.yaml Added mijn_host_api_key under the dns section and updated the provider list to include dns-mijn-host.
letsencrypt/rootfs/etc/cont-init.d/file-structure.sh Added configuration option for dns_mijn_host_api_key.
letsencrypt/rootfs/etc/services.d/lets-encrypt/run Included support for the new DNS provider in the script logic.

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
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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 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 for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

coderabbitai[bot] avatar Sep 05 '24 06:09 coderabbitai[bot]

This needs a newer ACME version. Let's update Certbot first before adding more DNS challenge options.

agners avatar Sep 05 '24 06:09 agners

okay, I have raised PR in certbot repo, waiting for the maintainers to merge it.

shubhamku044 avatar Sep 05 '24 06:09 shubhamku044

Maybe I was a bit unclear: mijn certbot plug-in requires ACME 2.11.0, but we ship with 2.7.4 currently:

31.83     certbot-dns-mijn-host 0.0.3 depends on acme==2.11.0

Maybe you could ask certbot-dns-mijn-host to loosen that restriction, but I rather prefer to actually update the add-on to use the latest ACME 2.11.0. I am preparing a PR, hold on.

agners avatar Sep 05 '24 07:09 agners

thanks, I saw you new PR where you upgrade the acme version

shubhamku044 avatar Sep 05 '24 17:09 shubhamku044

by when can you merge this pr @agners

shubhamku044 avatar Sep 06 '24 11:09 shubhamku044

@shubhamku044 with #3751 merged, you can now rebase/merge this PR and move forward.

agners avatar Sep 26 '24 16:09 agners

Hm, seems there is still a merge conflict:

 #7 35.42 The conflict is caused by:
#7 35.42     The user requested cryptography==43.0.1
#7 35.42     certbot 2.11.0 depends on cryptography>=3.2.1
#7 35.42     certbot-dns-mijn-host 0.0.3 depends on cryptography==43.0.0

I guess the bump now bumped cryptography too high (to 43.0.1 :see_no_evil: ). Can the plug-in maybe loosen that restriction :thinking:

agners avatar Sep 26 '24 16:09 agners

sure, I will make the necessary changes

shubhamku044 avatar Sep 26 '24 16:09 shubhamku044

FWIW, PR #3776 reverts Cryptography to 42 also for another reason, so you can rebase on this instead.

agners avatar Sep 27 '24 07:09 agners

hey @agners I have changed the version of cryptography, now it will work fine

shubhamku044 avatar Nov 01 '24 11:11 shubhamku044

hi @agners

shubhamku044 avatar Nov 06 '24 10:11 shubhamku044

When will this PR be merged into master? I was planning developing support for this provider, but then I saw there was this PR already with the functionality.

kevinhagenaars avatar Nov 17 '24 13:11 kevinhagenaars