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.

Sign up for GitHub

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

Jump to bottom

letsencrypt Addon: Fix issue 3606. Add transip global_key parameter #3835

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

letsencrypt Addon: Fix issue 3606. Add transip global_key parameter #3835

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
900711c
letsencrypt Addon: Fix issue 3606. Add transip global_key parameter
nathansamson Nov 23, 2024
3a53f5a
Add documentation
nathansamson Nov 23, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions letsencrypt/DOCS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -146,6 +146,7 @@ gandi_token: ''
gandi_sharing_id: ''
transip_username: ''
transip_api_key: ''
transip_global_key: ''
inwx_username: ''
inwx_password: ''
inwx_shared_secret: ''
Expand Down Expand Up @@ -646,6 +647,8 @@ Example configuration:

You will need to generate an API key from the TransIP Control Panel at https://www.transip.nl/cp/account/api/.

If you can't use IP whitelisting, use the `transip_global_key` and set it to yes. (https://github.com/hsmade/certbot-dns-transip/blob/master/USAGE.rst#ip-whitelistsing)

The propagation limit will be automatically raised to 240 seconds.

Example configuration:
Expand Down
1 change: 1 addition & 0 deletions letsencrypt/rootfs/etc/cont-init.d/file-structure.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,7 @@ echo -e "dns_desec_token = $(bashio::config 'dns.desec_token')\n" \
"dns_sakuracloud_api_token = $(bashio::config 'dns.sakuracloud_api_token')\n" \
"dns_sakuracloud_api_secret = $(bashio::config 'dns.sakuracloud_api_secret')\n" \
"dns_transip_username = $(bashio::config 'dns.transip_username')\n" \
"dns_transip_global_key = $(bashio::config 'dns.transip_global_key')\n" \
Copy link
Contributor

Choose a reason for hiding this comment

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

💡 Codebase verification

Documentation needs to be updated for TransIP global key

The new dns.transip_global_key parameter is added to the configuration but not documented in DOCS.md. The documentation only mentions the username and API key authentication method.

  • Update letsencrypt/DOCS.md to include:
    • Documentation for the new transip_global_key parameter
    • Example configuration showing the global key authentication method
    • Any specific requirements or limitations for using the global key
🔗 Analysis chain

LGTM! Verify TransIP global key integration.

The new parameter is correctly integrated alongside existing TransIP configurations and follows the established naming convention.

Let's verify the TransIP configuration handling:

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify TransIP configuration handling and documentation

# Check if TransIP configuration is documented
rg -l "transip_global_key" --type md

# Check for any existing TransIP key handling patterns
rg "transip.*key" --type bash

Length of output: 97

Script:

#!/bin/bash
# Let's try different approaches to verify TransIP configuration

# Check documentation files for TransIP global key
rg -l "transip.*global.*key" --type-add 'docs:*.{md,txt,rst}' -tdocs

# Check shell scripts for TransIP key handling (using .sh extension)
fd -e sh -x rg -l "transip.*key" {}

# Look for TransIP configuration patterns in shell scripts
fd -e sh -x rg "dns.transip" {}

# Check for any documentation about TransIP DNS configuration
rg -l "transip" --type-add 'docs:*.{md,txt,rst}' -tdocs

Length of output: 603

Script:

#!/bin/bash
# Let's check the documentation content and related configuration

# Check the content of DOCS.md for TransIP documentation
rg -A 5 -B 5 "transip" letsencrypt/DOCS.md

# Look for any configuration schema that might define these parameters
fd -e json -x rg -l "transip" {}
fd -e json -x cat {} | grep -i "transip" -A 5 -B 5

Length of output: 1253

"dns_transip_key_file = /data/transip-rsa.key\n" \
"dns_inwx_url = https://api.domrobot.com/xmlrpc/\n" \
"dns_inwx_username = $(bashio::config 'dns.inwx_username')\n" \
Expand Down