From 9ec4353ab2cbd6046f030341fbba6d4715d06e8e Mon Sep 17 00:00:00 2001 From: noadc-dev Date: Tue, 25 Feb 2025 16:55:34 -0500 Subject: [PATCH 1/5] Fix typo in README.md Fix minor typographical errors from previous commit --- README.md | 25 +++++++++---------------- 1 file changed, 9 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 5a7ac7c..8a6d7b4 100644 --- a/README.md +++ b/README.md @@ -114,7 +114,7 @@ services: container_name: porkbun-ddns environment: DOMAIN: "domain.com" # Your Porkbun domain - SUBDOMAINS: "my_subdomain,my_other_subdomain,my_subsubdomain.my_subdomain" # Comma-separated subdomains + SUBDOMAINS: "my_subdomain,my_other_subdomain,my_subsubdomain.my_subdomain" # Subdomains separated by commas. Can be left empty. SECRETAPIKEY: "" # Pass your Porkbun Secret API Key in plaintext APIKEY: "" # Pass your Porkbun API Key in plaintext # PUBLIC_IPS: "1.2.3.4,2001:043e::1" # Set if you have static IPs @@ -135,10 +135,16 @@ services: container_name: porkbun-ddns environment: DOMAIN: "domain.com" - SUBDOMAINS: "my_subdomain,my_other_subdomain,my_subsubdomain.my_subdomain" + SUBDOMAINS: "my_subdomain,my_other_subdomain,my_subsubdomain.my_subdomain" # Subdomains separated by commas. Can be left empty. APIKEY_FILE: "/run/secrets/PORKBUN_API_KEY" # Read API key from Docker secret SECRETAPIKEY_FILE: "/run/secrets/PORKBUN_SECRET_API_KEY" # Read secret API key from Docker secret - restart: unless-stopped + # PUBLIC_IPS: "1.2.3.4,2001:043e::1" # Set if you have static IPs + # FRITZBOX: "192.168.178.1" # Use Fritz!BOX to obtain public IPs + # SLEEP: "300" # Seconds to sleep between DynDNS runs + # IPV4: "TRUE" # Enable IPv4 + # IPV6: "TRUE" # Enable IPv6 + # DEBUG: "FALSE" # Enable debug logging + restart: unless-stopped secrets: - PORKBUN_API_KEY - PORKBUN_SECRET_API_KEY @@ -179,16 +185,3 @@ docker run -d \ --restart unless-stopped \ noadc-dev/porkbun-ddns:latest ``` - ---- - -### Key Improvements: - -1. **Grammar and Clarity:** Improved sentence structure for better readability. -2. **Consistency:** - - Standardized punctuation and formatting. - - Ensured all references to variables, commands, and services were uniform. -3. **Code Formatting:** Ensured proper indentation in YAML files for readability. -4. **Spelling Fixes:** Fixed minor typos and inconsistencies. - -Your README is now clearer, more professional, and easier to follow. 🚀 Let me know if you need any additional tweaks! \ No newline at end of file From 8c118141fc2dafb260db419e613874c1364ff4fd Mon Sep 17 00:00:00 2001 From: noadc-dev Date: Tue, 25 Feb 2025 17:14:26 -0500 Subject: [PATCH 2/5] Fix minor typo in README.MD --- README.md | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 8a6d7b4..75879cd 100644 --- a/README.md +++ b/README.md @@ -114,7 +114,7 @@ services: container_name: porkbun-ddns environment: DOMAIN: "domain.com" # Your Porkbun domain - SUBDOMAINS: "my_subdomain,my_other_subdomain,my_subsubdomain.my_subdomain" # Subdomains separated by commas. Can be left empty. + SUBDOMAINS: "my_subdomain,my_other_subdomain,my_subsubdomain.my_subdomain" # Subdomains, separated by commas. Can be left empty. SECRETAPIKEY: "" # Pass your Porkbun Secret API Key in plaintext APIKEY: "" # Pass your Porkbun API Key in plaintext # PUBLIC_IPS: "1.2.3.4,2001:043e::1" # Set if you have static IPs @@ -134,8 +134,8 @@ services: image: "mietzen/porkbun-ddns:latest" container_name: porkbun-ddns environment: - DOMAIN: "domain.com" - SUBDOMAINS: "my_subdomain,my_other_subdomain,my_subsubdomain.my_subdomain" # Subdomains separated by commas. Can be left empty. + DOMAIN: "domain.com" # Your Porkbun domain + SUBDOMAINS: "my_subdomain,my_other_subdomain,my_subsubdomain.my_subdomain" # Subdomains, separated by commas. Can be left empty. APIKEY_FILE: "/run/secrets/PORKBUN_API_KEY" # Read API key from Docker secret SECRETAPIKEY_FILE: "/run/secrets/PORKBUN_SECRET_API_KEY" # Read secret API key from Docker secret # PUBLIC_IPS: "1.2.3.4,2001:043e::1" # Set if you have static IPs @@ -151,9 +151,9 @@ services: secrets: PORKBUN_API_KEY: - file: /path/to/secrets/PORKBUN_API_KEY # Replace with actual directory + file: /path/to/secrets/PORKBUN_API_KEY # Replace `/path/to/secrets/` with the actual directory where your secrets are stored. PORKBUN_SECRET_API_KEY: - file: /path/to/secrets/PORKBUN_SECRET_API_KEY # Replace with actual directory + file: /path/to/secrets/PORKBUN_SECRET_API_KEY # Replace `/path/to/secrets/` with the actual directory where your secrets are stored. ``` --- @@ -179,7 +179,9 @@ docker run -d \ -e SUBDOMAINS="my_subdomain,my_other_subdomain" \ -e APIKEY_FILE="/run/secrets/PORKBUN_API_KEY" \ -e SECRETAPIKEY_FILE="/run/secrets/PORKBUN_SECRET_API_KEY" \ - --mount type=bind,source=/path/to/secrets/PORKBUN_API_KEY,target=/run/secrets/PORKBUN_API_KEY,readonly \ + # Mount the secret files so they can be accessed by the container + # Replace `/path/to/secrets/` with the actual directory where your secrets are stored. + --mount type=bind,source=/path/to/secrets/PORKBUN_API_KEY,target=/run/secrets/PORKBUN_API_KEY,readonly \ --mount type=bind,source=/path/to/secrets/PORKBUN_SECRET_API_KEY,target=/run/secrets/PORKBUN_SECRET_API_KEY,readonly \ --name porkbun-ddns \ --restart unless-stopped \ From f24abbc472a1e146819e18b1d916411a30f18df2 Mon Sep 17 00:00:00 2001 From: noadc-dev Date: Tue, 25 Feb 2025 17:24:19 -0500 Subject: [PATCH 3/5] FIx type in README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 75879cd..57008e0 100644 --- a/README.md +++ b/README.md @@ -144,7 +144,7 @@ services: # IPV4: "TRUE" # Enable IPv4 # IPV6: "TRUE" # Enable IPv6 # DEBUG: "FALSE" # Enable debug logging - restart: unless-stopped + restart: unless-stopped secrets: - PORKBUN_API_KEY - PORKBUN_SECRET_API_KEY From 5e29ad4b6dc0fce9596b2308579c862bc1ad73d1 Mon Sep 17 00:00:00 2001 From: noadc-dev Date: Tue, 25 Feb 2025 17:25:33 -0500 Subject: [PATCH 4/5] Fixed typo in README.md --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 57008e0..d2b4c01 100644 --- a/README.md +++ b/README.md @@ -143,8 +143,8 @@ services: # SLEEP: "300" # Seconds to sleep between DynDNS runs # IPV4: "TRUE" # Enable IPv4 # IPV6: "TRUE" # Enable IPv6 - # DEBUG: "FALSE" # Enable debug logging - restart: unless-stopped + # DEBUG: "FALSE" # Enable debug logging + restart: unless-stopped secrets: - PORKBUN_API_KEY - PORKBUN_SECRET_API_KEY From 5a9353668c70e208e979038b098094938725e4c0 Mon Sep 17 00:00:00 2001 From: noadc-dev Date: Tue, 25 Feb 2025 17:28:44 -0500 Subject: [PATCH 5/5] Fixed typos in README.md --- README.md | 19 ++++++++++--------- 1 file changed, 10 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index d2b4c01..538ff70 100644 --- a/README.md +++ b/README.md @@ -114,9 +114,9 @@ services: container_name: porkbun-ddns environment: DOMAIN: "domain.com" # Your Porkbun domain - SUBDOMAINS: "my_subdomain,my_other_subdomain,my_subsubdomain.my_subdomain" # Subdomains, separated by commas. Can be left empty. - SECRETAPIKEY: "" # Pass your Porkbun Secret API Key in plaintext - APIKEY: "" # Pass your Porkbun API Key in plaintext + SUBDOMAINS: "my_subdomain,my_other_subdomain,my_subsubdomain.my_subdomain" + SECRETAPIKEY: "" + APIKEY: "" # PUBLIC_IPS: "1.2.3.4,2001:043e::1" # Set if you have static IPs # FRITZBOX: "192.168.178.1" # Use Fritz!BOX to obtain public IPs # SLEEP: "300" # Seconds to sleep between DynDNS runs @@ -135,9 +135,9 @@ services: container_name: porkbun-ddns environment: DOMAIN: "domain.com" # Your Porkbun domain - SUBDOMAINS: "my_subdomain,my_other_subdomain,my_subsubdomain.my_subdomain" # Subdomains, separated by commas. Can be left empty. - APIKEY_FILE: "/run/secrets/PORKBUN_API_KEY" # Read API key from Docker secret - SECRETAPIKEY_FILE: "/run/secrets/PORKBUN_SECRET_API_KEY" # Read secret API key from Docker secret + SUBDOMAINS: "my_subdomain,my_other_subdomain,my_subsubdomain.my_subdomain" + APIKEY_FILE: "/run/secrets/PORKBUN_API_KEY" + SECRETAPIKEY_FILE: "/run/secrets/PORKBUN_SECRET_API_KEY" # PUBLIC_IPS: "1.2.3.4,2001:043e::1" # Set if you have static IPs # FRITZBOX: "192.168.178.1" # Use Fritz!BOX to obtain public IPs # SLEEP: "300" # Seconds to sleep between DynDNS runs @@ -150,10 +150,11 @@ services: - PORKBUN_SECRET_API_KEY secrets: + # Replace `/path/to/secrets/` with the actual directory where your secrets are stored. PORKBUN_API_KEY: - file: /path/to/secrets/PORKBUN_API_KEY # Replace `/path/to/secrets/` with the actual directory where your secrets are stored. + file: /path/to/secrets/PORKBUN_API_KEY PORKBUN_SECRET_API_KEY: - file: /path/to/secrets/PORKBUN_SECRET_API_KEY # Replace `/path/to/secrets/` with the actual directory where your secrets are stored. + file: /path/to/secrets/PORKBUN_SECRET_API_KEY ``` --- @@ -181,7 +182,7 @@ docker run -d \ -e SECRETAPIKEY_FILE="/run/secrets/PORKBUN_SECRET_API_KEY" \ # Mount the secret files so they can be accessed by the container # Replace `/path/to/secrets/` with the actual directory where your secrets are stored. - --mount type=bind,source=/path/to/secrets/PORKBUN_API_KEY,target=/run/secrets/PORKBUN_API_KEY,readonly \ + --mount type=bind,source=/path/to/secrets/PORKBUN_API_KEY,target=/run/secrets/PORKBUN_API_KEY,readonly \ --mount type=bind,source=/path/to/secrets/PORKBUN_SECRET_API_KEY,target=/run/secrets/PORKBUN_SECRET_API_KEY,readonly \ --name porkbun-ddns \ --restart unless-stopped \