Merge pull request #66 from linuxserver/drizuid-patch-1

Make readme more clear on use, update changelog

Author: drizuid

README.md

@@ -60,7 +60,7 @@ The architectures supported by this image are:
 ## Application Setup
 
 - Go to the [duckdns website](https://duckdns.org/), register your subdomain(s) and retrieve your token
-- Create a container with your subdomain(s) and token
+- Create a container with your subdomain(s) and token. If you own user.duckdns.org, you put `SUBDOMAINS=user` you would NOT put a sub subdomain like overseerr from overseerr.user.ducksdns.org
 - It will update your IP with the DuckDNS service every 5 minutes (with a random jitter)
 
 ## Usage
@@ -113,7 +113,7 @@ Containers are configured using parameters passed at runtime (such as those abov
 | `-e PUID=1000` | for UserID - see below for explanation |
 | `-e PGID=1000` | for GroupID - see below for explanation |
 | `-e TZ=Etc/UTC` | specify a timezone to use, see this [list](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List). |
-| `-e SUBDOMAINS=subdomain1,subdomain2` | multiple subdomains allowed, comma separated, no spaces |
+| `-e SUBDOMAINS=subdomain1,subdomain2` | multiple subdomains allowed, comma separated, no spaces, if your domain is user.duckdns.org you put user, not a sub-subdomain |
 | `-e TOKEN=token` | DuckDNS token |
 | `-e LOG_FILE=false` | Set to `true` to log to file (also need to map /config). |
 | `-v /config` | Used in conjunction with logging to file. |
@@ -296,6 +296,7 @@ Once registered you can define the dockerfile to use with `-f Dockerfile.aarch64
 
 ## Versions
 
+* **14.10.23:** - Rework shell script for case insensitivity and update readme to be more clear.
 * **25.05.23:** - Rebase to Alpine 3.18, deprecate armhf.
 * **02.03.23:** - Rework shell scripts and cron logic.
 * **13.02.23:** - Rebase to alpine 3.17.

readme-vars.yml

@@ -25,7 +25,7 @@ param_net_desc: ""
 param_usage_include_env: true
 param_env_vars:
   - { env_var: "TZ", env_value: "Europe/London", desc: "Specify a timezone to use EG Europe/London"}
-  - { env_var: "SUBDOMAINS", env_value: "subdomain1,subdomain2", desc: "multiple subdomains allowed, comma separated, no spaces"}
+  - { env_var: "SUBDOMAINS", env_value: "subdomain1,subdomain2", desc: "multiple subdomains allowed, comma separated, no spaces, if your domain is user.duckdns.org you put user, not a sub-subdomain"}
   - { env_var: "TOKEN", env_value: "token", desc: "DuckDNS token"}
 param_usage_include_vols: false
 param_volumes: ""
@@ -58,11 +58,12 @@ optional_block_1_items: ""
 app_setup_block_enabled: true
 app_setup_block: |
   - Go to the [duckdns website]({{project_url}}), register your subdomain(s) and retrieve your token
-  - Create a container with your subdomain(s) and token
+  - Create a container with your subdomain(s) and token. If you own user.duckdns.org, you put `SUBDOMAINS=user` you would NOT put a sub subdomain like overseerr from overseerr.user.ducksdns.org
   - It will update your IP with the DuckDNS service every 5 minutes (with a random jitter)
 
 # changelog
 changelogs:
+  - { date: "14.10.23:", desc: "Rework shell script for case insensitivity and update readme to be more clear." }
   - { date: "25.05.23:", desc: "Rebase to Alpine 3.18, deprecate armhf." }
   - { date: "02.03.23:", desc: "Rework shell scripts and cron logic." }
   - { date: "13.02.23:", desc: "Rebase to alpine 3.17." }