add acmedns to the letsencrypt dns plugins #3897
Conversation
![home-assistant[bot]](https://avatars.githubusercontent.com/in/97978?s=60&v=4){kind=small}
home-assistant
bot
added
cla-needed
cla-recheck
cla-signed
and removed
cla-recheck
cla-needed
labels
📝 WalkthroughWalkthroughThe pull request introduces support for the ACME-DNS (dns-acmedns) DNS provider in the Let's Encrypt add-on. This enhancement involves updates across multiple configuration files to enable users to use ACME-DNS for certificate issuance. The changes include adding a new DNS provider option, updating the Dockerfile to install the necessary plugin, modifying configuration files to support new parameters, and extending the run script to handle ACME-DNS specific authentication and configuration. Changes
Sequence DiagramsequenceDiagram
participant User
participant Config
participant Dockerfile
participant RunScript
participant CertbotPlugin
User->>Config: Provide ACME-DNS configuration
Config->>RunScript: Pass DNS provider and credentials
RunScript->>CertbotPlugin: Configure ACME-DNS authentication
CertbotPlugin->>RunScript: Validate credentials
RunScript->>User: Generate SSL Certificate
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? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (4)
letsencrypt/config.yaml (1)
43-44: Consider adding schema validation for the URL field.The
acmedns_urlfield could benefit from URL validation similar to theacme_serverfield which uses theurl?type instead ofstr?.Apply this diff to add URL validation:
- acmedns_url: str? + acmedns_url: url? acmedns_credentials: str?letsencrypt/DOCS.md (3)
354-354: Add a comma before 'and'.Add a comma to improve readability: "This plugin does not do ACME-DNS registration, and you are responsible..."
🧰 Tools
🪛 LanguageTool
[uncategorized] ~354-~354: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...plugin does not do ACME-DNS registration and you are responsible to make sure /share...(COMMA_COMPOUND_SENTENCE)
377-380: Enhance the registration instructions.The registration instructions could be more detailed. Consider adding:
- A note about the expected response format
- Error handling information
- The full API endpoint URL format
Would you like me to provide enhanced registration instructions?
811-811: Add language specifier to the code block.Add a language specifier to the fenced code block for better syntax highlighting.
- ``` + ```txt🧰 Tools
🪛 Markdownlint (0.37.0)
811-811: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (5)
letsencrypt/DOCS.md(8 hunks)letsencrypt/Dockerfile(2 hunks)letsencrypt/build.yaml(1 hunks)letsencrypt/config.yaml(2 hunks)letsencrypt/rootfs/etc/services.d/lets-encrypt/run(3 hunks)
🧰 Additional context used
📓 Path-based instructions (4)
letsencrypt/build.yaml (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.
letsencrypt/config.yaml (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.
letsencrypt/Dockerfile (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.
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.
🪛 LanguageTool
letsencrypt/DOCS.md
[uncategorized] ~354-~354: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...plugin does not do ACME-DNS registration and you are responsible to make sure /share...
(COMMA_COMPOUND_SENTENCE)
[style] ~991-~991: Consider a shorter alternative to avoid wordiness.
Context: ...PI access must be requested and granted in order to use this module: https://cp.easydns.com...
(IN_ORDER_TO_PREMIUM)
🪛 Gitleaks (8.21.2)
letsencrypt/DOCS.md
360-360: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
367-367: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
🪛 Markdownlint (0.37.0)
letsencrypt/DOCS.md
811-811: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
991-991: null
Bare URL used
(MD034, no-bare-urls)
🔇 Additional comments (4)
letsencrypt/build.yaml (1)
15-15: LGTM!The version specification follows the established pattern and uses semantic versioning.
letsencrypt/Dockerfile (1)
10-10: LGTM!The changes follow the established pattern for adding new DNS provider packages:
- Build argument is properly defined
- Package is installed with version pinning
Also applies to: 58-58
letsencrypt/DOCS.md (2)
43-43: LGTM!The new DNS provider is correctly added to the list in alphabetical order.
91-92: LGTM!The new configuration fields are correctly added and follow the existing format.
|
@coderabbitai full review |
There was a problem hiding this comment.
Actionable comments posted: 4
🧹 Nitpick comments (4)
letsencrypt/rootfs/etc/services.d/lets-encrypt/run (1)
207-224: Add error handling for invalid credentials file.While the implementation correctly handles the case when the credentials file doesn't exist, it should also validate the file content to ensure it's properly formatted.
Apply this diff to add validation:
if [ -f "/share/${ACMEDNS_CREDENTIALS}" ]; then cp -f "/share/${ACMEDNS_CREDENTIALS}" "/data/dnsdomains" chmod 600 "/data/dnsdomains" + if ! jq -e . >/dev/null 2>&1 < "/data/dnsdomains"; then + bashio::log.error "AcmeDNS domains file is not valid JSON" + exit 1 + fi else bashio::log.info "AcmeDNS domains file doesn't exist in folder share." filetsencrypt/DOCS.md (3)
811-811: Add language specifier to the code block.Add a language specifier to the fenced code block for better syntax highlighting.
Apply this change:
- ``` + ```conf🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
811-811: Fenced code blocks should have a language specified
null(MD040, fenced-code-language)
354-354: Add comma for better readability.Add a comma before 'and' to improve sentence structure.
Apply this change:
-This plugin does not do ACME-DNS registration and you are responsible +This plugin does not do ACME-DNS registration, and you are responsible🧰 Tools
🪛 LanguageTool
[uncategorized] ~354-~354: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...plugin does not do ACME-DNS registration and you are responsible to make sure /share...(COMMA_COMPOUND_SENTENCE)
991-991: Format the bare URL.Use proper Markdown link syntax for the URL.
Apply this change:
-easyDNS REST API access must be requested and granted in order to use this module: https://cp.easydns.com/manage/security/api/signup.php after logging into your account. +easyDNS REST API access must be requested and granted in order to use this module: [sign up for API access](https://cp.easydns.com/manage/security/api/signup.php) after logging into your account.🧰 Tools
🪛 LanguageTool
[style] ~991-~991: Consider a shorter alternative to avoid wordiness.
Context: ...PI access must be requested and granted in order to use this module: https://cp.easydns.com...(IN_ORDER_TO_PREMIUM)
🪛 markdownlint-cli2 (0.17.2)
991-991: Bare URL used
null(MD034, no-bare-urls)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (5)
letsencrypt/DOCS.md(8 hunks)letsencrypt/Dockerfile(2 hunks)letsencrypt/build.yaml(1 hunks)letsencrypt/config.yaml(2 hunks)letsencrypt/rootfs/etc/services.d/lets-encrypt/run(3 hunks)
🧰 Additional context used
📓 Path-based instructions (4)
letsencrypt/build.yaml (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.
letsencrypt/Dockerfile (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.
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.
letsencrypt/config.yaml (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.
🪛 LanguageTool
letsencrypt/DOCS.md
[uncategorized] ~354-~354: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...plugin does not do ACME-DNS registration and you are responsible to make sure /share...
(COMMA_COMPOUND_SENTENCE)
[style] ~991-~991: Consider a shorter alternative to avoid wordiness.
Context: ...PI access must be requested and granted in order to use this module: https://cp.easydns.com...
(IN_ORDER_TO_PREMIUM)
🪛 Gitleaks (8.21.2)
letsencrypt/DOCS.md
360-360: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
367-367: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
🪛 markdownlint-cli2 (0.17.2)
letsencrypt/DOCS.md
811-811: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
991-991: Bare URL used
null
(MD034, no-bare-urls)
🔇 Additional comments (4)
letsencrypt/config.yaml (1)
43-44: LGTM!The configuration schema changes are well-structured:
- Correct types for new fields
- Optional fields marked with
?- Provider added in alphabetical order
Also applies to: 108-108
letsencrypt/Dockerfile (1)
10-10: LGTM!The Dockerfile changes follow the established patterns:
- Build argument added consistently
- Package installation follows alphabetical order
- Version controlled via build argument
Also applies to: 58-58
letsencrypt/DOCS.md (2)
43-43: LGTM!The new DNS provider is correctly added to the list in alphabetical order.
91-92: LGTM!The new configuration fields are correctly added with appropriate placeholders.
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
letsencrypt/DOCS.md (2)
354-354: Add a comma in the compound sentence.Add a comma before 'and' to improve readability.
Apply this change:
-This plugin does not do ACME-DNS account registration and you are responsible +This plugin does not do ACME-DNS account registration, and you are responsible🧰 Tools
🪛 LanguageTool
[uncategorized] ~354-~354: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...oes not do ACME-DNS account registration and you are responsible to make sure /share...(COMMA_COMPOUND_SENTENCE)
383-391: Add language specifier to the code block.Add 'json' as the language specifier for proper syntax highlighting.
Apply this change:
-``` +```json { "username": "...", "password": "...", "fulldomain": "...", "subdomain": "...". "allowfrom": [] }<details> <summary>🧰 Tools</summary> <details> <summary>🪛 markdownlint-cli2 (0.17.2)</summary> 383-383: Fenced code blocks should have a language specified null (MD040, fenced-code-language) </details> </details> </blockquote></details> </blockquote></details> <details> <summary>📜 Review details</summary> **Configuration used: CodeRabbit UI** **Review profile: CHILL** **Plan: Pro** <details> <summary>📥 Commits</summary> Reviewing files that changed from the base of the PR and between df2024545c41f24f31d31876d86867982fcb5119 and 9f308913ce4227bd397ae090ba742af7fe7298be. </details> <details> <summary>📒 Files selected for processing (1)</summary> * `letsencrypt/DOCS.md` (8 hunks) </details> <details> <summary>🧰 Additional context used</summary> <details> <summary>📓 Path-based instructions (1)</summary> <details> <summary>letsencrypt/DOCS.md (6)</summary> 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. </details> </details><details> <summary>🪛 LanguageTool</summary> <details> <summary>letsencrypt/DOCS.md</summary> [uncategorized] ~354-~354: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short). Context: ...oes not do ACME-DNS account registration and you are responsible to make sure /share... (COMMA_COMPOUND_SENTENCE) --- [uncategorized] ~381-~381: Possible missing article found. Context: ...T http://auth.example.com/register ``` Response will contain the credentials in JSON fo... (AI_HYDRA_LEO_MISSING_THE) --- [style] ~1009-~1009: Consider a shorter alternative to avoid wordiness. Context: ...PI access must be requested and granted in order to use this module: https://cp.easydns.com... (IN_ORDER_TO_PREMIUM) </details> </details> <details> <summary>🪛 Gitleaks (8.21.2)</summary> <details> <summary>letsencrypt/DOCS.md</summary> 360-360: Detected a Generic API Key, potentially exposing access to various services and sensitive operations. (generic-api-key) --- 367-367: Detected a Generic API Key, potentially exposing access to various services and sensitive operations. (generic-api-key) </details> </details> <details> <summary>🪛 markdownlint-cli2 (0.17.2)</summary> <details> <summary>letsencrypt/DOCS.md</summary> 383-383: Fenced code blocks should have a language specified null (MD040, fenced-code-language) --- 829-829: Fenced code blocks should have a language specified null (MD040, fenced-code-language) --- 1009-1009: Bare URL used null (MD034, no-bare-urls) </details> </details> </details> <details> <summary>🔇 Additional comments (3)</summary><blockquote> <details> <summary>letsencrypt/DOCS.md (3)</summary> `43-43`: **LGTM!** The new DNS provider is correctly added to the list in alphabetical order. --- `91-92`: **LGTM!** The new configuration fields are correctly added with consistent formatting and defaults. --- `377-380`: _:hammer_and_wrench: Refactor suggestion_ **Use HTTPS for API calls and clarify the response format.** For security reasons, use HTTPS instead of HTTP for the API call. Apply this change: ```diff -curl -X POST http://auth.example.com/register +curl -X POST https://auth.example.com/registerLikely invalid or redundant comment.
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
letsencrypt/DOCS.md (2)
829-829: Add language specifier to fenced code block.Add a language specifier to the fenced code block for better syntax highlighting.
Apply this change:
- ``` + ```txt🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
829-829: Fenced code blocks should have a language specified
null(MD040, fenced-code-language)
1009-1009: Use proper link formatting.Use proper markdown link formatting instead of bare URLs for better accessibility.
Apply this change:
-easyDNS REST API access must be requested and granted in order to use this module: https://cp.easydns.com/manage/security/api/signup.php after logging into your account. +easyDNS REST API access must be requested and granted in order to use this module: [API signup](https://cp.easydns.com/manage/security/api/signup.php) after logging into your account.🧰 Tools
🪛 LanguageTool
[style] ~1009-~1009: Consider a shorter alternative to avoid wordiness.
Context: ...PI access must be requested and granted in order to use this module: https://cp.easydns.com...(IN_ORDER_TO_PREMIUM)
🪛 markdownlint-cli2 (0.17.2)
1009-1009: Bare URL used
null(MD034, no-bare-urls)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
letsencrypt/DOCS.md(8 hunks)
🧰 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.
🪛 Gitleaks (8.21.2)
letsencrypt/DOCS.md
360-360: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
367-367: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
🪛 markdownlint-cli2 (0.17.2)
letsencrypt/DOCS.md
829-829: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
1009-1009: Bare URL used
null
(MD034, no-bare-urls)
🪛 LanguageTool
letsencrypt/DOCS.md
[style] ~1009-~1009: Consider a shorter alternative to avoid wordiness.
Context: ...PI access must be requested and granted in order to use this module: https://cp.easydns.com...
(IN_ORDER_TO_PREMIUM)
🔇 Additional comments (4)
letsencrypt/DOCS.md (4)
43-43: LGTM!The new DNS provider is correctly added to the list in alphabetical order.
91-92: LGTM!The new configuration fields follow the established pattern and format.
338-402: LGTM!The acme-dns challenge section is well-documented with clear instructions, examples, and proper formatting.
🧰 Tools
🪛 Gitleaks (8.21.2)
360-360: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
367-367: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
377-380:⚠️ Potential issueUse HTTPS for the registration endpoint.
For security reasons, use HTTPS instead of HTTP when making API calls to the ACME-DNS server.
Apply this change:
-curl -X POST http://auth.example.com/register +curl -X POST https://auth.example.com/registerLikely invalid or redundant comment.
with this PR I added the acmedns plugin to letsencrypt.
I could not figure out how to properly test it on my instance so far. Any tip on how to get the docker container running on an hassos instance are very welcome.
Summary by CodeRabbit
Release Notes
New Features
Documentation
Improvements