Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Eurodns DNS support #3912

Closed
wants to merge 0 commits into from
Closed

Add Eurodns DNS support #3912

wants to merge 0 commits into from

Conversation

chwdt
Copy link
Contributor

@chwdt chwdt commented Feb 3, 2025

This commit add support for Eurodns DNS challenges using the certbot plugin provided by Eurodns.

See https://eurodns.com and https://pypi.org/project/certbot-dns-eurodns for further info

Summary by CodeRabbit

  • New Features
    • Enabled support for a new DNS provider, EuroDNS, allowing SSL certificate generation using additional credentials.
    • Enhanced the build process with an option to specify the EuroDNS plugin version.
  • Documentation
    • Updated guides and provided sample configuration steps to help users set up EuroDNS.

Copy link

@home-assistant home-assistant bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @chwdt

It seems you haven't yet signed a CLA. Please do so here.

Once you do that we will be able to review and accept this pull request.

Thanks!

@home-assistant
Copy link

home-assistant bot commented Feb 3, 2025

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

Learn more about our pull request process.

@home-assistant home-assistant bot marked this pull request as draft February 3, 2025 15:27
@chwdt chwdt marked this pull request as ready for review February 3, 2025 15:29
Copy link
Contributor

coderabbitai bot commented Feb 3, 2025

📝 Walkthrough

Walkthrough

The changes integrate EuroDNS as a new DNS provider for the Letsencrypt add-on. Documentation is updated with a dedicated section and sample YAML for EuroDNS configuration, while configuration files are enhanced with new optional fields and an updated version number. The build files now include a new argument for specifying the Certbot EuroDNS plugin version, and both the file-structure and run service scripts add logic to handle EuroDNS credentials and processing during DNS challenges.

Changes

Files Change Summary
letsencrypt/DOCS.md
letsencrypt/config.yaml
Updated documentation and configuration: Added EuroDNS provider details, new fields (eurodns_applicationId, eurodns_apiKey), and updated allowed provider list/version bump (5.2.11 → 5.2.12).
letsencrypt/Dockerfile
letsencrypt/build.yaml
Updated build configuration: Added new build argument CERTBOT_DNS_EURODNS_VERSION and corresponding installation command for certbot-dns-eurodns, with version specified (1.8.1).
letsencrypt/rootfs/.../file-structure.sh
letsencrypt/rootfs/.../services.d/lets-encrypt/run
Updated initialization and runtime scripts: Added new configuration parameters for EuroDNS (dns_eurodns_applicationId, dns_eurodns_apiKey) and a conditional branch to handle dns-eurodns challenges during certificate generation.

Sequence Diagram(s)

sequenceDiagram
    participant Operator as User/Operator
    participant Script as Run Script
    participant Config as Config Files
    participant EuroDNS as EuroDNS Provider

    Operator->>Script: Initiate certificate request
    Script->>Config: Load DNS configuration settings
    alt DNS provider = dns-eurodns
        Script->>Script: Check for EuroDNS credentials (applicationId & apiKey)
        Script->>EuroDNS: Send DNS challenge request with EuroDNS credentials
    else Other DNS providers
        Script->>Script: Process as usual for selected DNS provider
    end
    EuroDNS-->>Script: Return DNS challenge response
    Script-->>Operator: Continue certificate issuance process
Loading

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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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.

Copy link
Member

@frenck frenck left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh hi there @chwdt 👋

A wild merge conflict appeared on this PR 🙈

Could you maybe take a look and resolve it?

Thanks! 👍

../Frenck

@home-assistant home-assistant bot marked this pull request as draft February 6, 2025 21:37
@chwdt chwdt marked this pull request as ready for review February 7, 2025 08:02
@home-assistant home-assistant bot requested a review from frenck February 7, 2025 08:02
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (1)
letsencrypt/DOCS.md (1)

982-1001: Addition of Eurodns DNS challenge documentation section
The new details block for the Eurodns DNS challenge is well structured and consistent with the other DNS provider sections. The example YAML clearly demonstrates how to configure Eurodns with the required fields (eurodns_applicationId and eurodns_apiKey). Consider converting the bare URL (https://my.eurodns.com/apiusers) into a markdown link to meet documentation best practices.

🧰 Tools
🪛 markdownlint-cli2 (0.17.2)

985-985: Bare URL used
null

(MD034, no-bare-urls)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 1a7f0b2 and 2e9a850.

📒 Files selected for processing (6)
  • letsencrypt/DOCS.md (4 hunks)
  • letsencrypt/Dockerfile (2 hunks)
  • letsencrypt/build.yaml (1 hunks)
  • letsencrypt/config.yaml (2 hunks)
  • letsencrypt/rootfs/etc/cont-init.d/file-structure.sh (1 hunks)
  • letsencrypt/rootfs/etc/services.d/lets-encrypt/run (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (4)
  • letsencrypt/rootfs/etc/cont-init.d/file-structure.sh
  • letsencrypt/build.yaml
  • letsencrypt/config.yaml
  • letsencrypt/rootfs/etc/services.d/lets-encrypt/run
🧰 Additional context used
📓 Path-based instructions (6)
`*/**(html|markdown|md)`: - For instructional content in doc...

*/**(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'
  • letsencrypt/Dockerfile
  • letsencrypt/DOCS.md
`*/**(html|markdown|md)`: - Use bold to mark UI strings. - I...

*/**(html|markdown|md): - Use bold to mark UI strings.

  • If "" are used to mark UI strings, replace them by bold.
  • letsencrypt/Dockerfile
  • letsencrypt/DOCS.md
`*/**(html|markdown|md)`: - Be brief in your replies and don...

*/**(html|markdown|md): - Be brief in your replies and don't add fluff like "thank you for..." and "Please let me know if"

  • letsencrypt/Dockerfile
  • letsencrypt/DOCS.md
`*/**(html|markdown|md)`: - Use sentence-style capitalizatio...

*/**(html|markdown|md): - Use sentence-style capitalization also in headings.

  • letsencrypt/Dockerfile
  • letsencrypt/DOCS.md
`*/**(html|markdown|md)`: do not comment on HTML used for ic...

*/**(html|markdown|md): do not comment on HTML used for icons

  • letsencrypt/Dockerfile
  • letsencrypt/DOCS.md
`*/**(html|markdown|md)`: Avoid flagging inline HTML for emb...

*/**(html|markdown|md): Avoid flagging inline HTML for embedding videos in future reviews for this repository.

  • letsencrypt/Dockerfile
  • letsencrypt/DOCS.md
🪛 markdownlint-cli2 (0.17.2)
letsencrypt/DOCS.md

985-985: Bare URL used
null

(MD034, no-bare-urls)

🔇 Additional comments (2)
letsencrypt/Dockerfile (2)

17-17: New build argument for Eurodns support added
The build argument CERTBOT_DNS_EURODNS_VERSION is inserted correctly into the multi-line ARG list. Verify that this variable is defined in your build configuration (for example, in build.yaml) to ensure proper version substitution during the Docker build.


68-68: Eurodns plugin installation command included correctly
The pip3 install command now installs certbot-dns-eurodns using the specified version via ${CERTBOT_DNS_EURODNS_VERSION}. Confirm that the provided version in the build configuration matches the expected plugin version to avoid any runtime discrepancies.

@chwdt
Copy link
Contributor Author

chwdt commented Feb 7, 2025

Hi @frenck,

the merge conflict should be resolved, I removed all changes to version strings in my PR.

/chwdt

Copy link
Member

@agners agners left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The slightly older PR #3902 which updates Certboot just made it in, so this PR needs a rebase. Sorry about that!

Make sure to also bump the version in config.yaml and add a log entry in README.md.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants