Skip to content

Commit

Permalink
further clarify readme
Browse files Browse the repository at this point in the history
  • Loading branch information
aptalca authored Apr 1, 2024
1 parent 3031632 commit c9fab86
Showing 1 changed file with 5 additions and 6 deletions.
11 changes: 5 additions & 6 deletions readme-vars.yml
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,6 @@ param_net: "host"
param_net_desc: "Use host networking for IPv6 detection"
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, 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
Expand All @@ -43,7 +42,7 @@ opt_param_env_vars:
- { env_var: "LOG_FILE", env_value: "false", desc: "Set to `true` to log to file (also need to map /config).", env_options: ["false", "true"] }
opt_param_usage_include_vols: true
opt_param_volumes:
- { vol_path: "/config", vol_host_path: "/path/to/{{ project_name }}/config", desc: "Persistent config files. Set to true to keep address history." }
- { vol_path: "/config", vol_host_path: "/path/to/{{ project_name }}/config", desc: "Persistent config files. Also et `LOG_FILE=true` to keep address history." }
opt_param_usage_include_ports: false
opt_param_ports: ""
opt_param_device_map: false
Expand All @@ -58,9 +57,9 @@ optional_block_1_items: ""
# application setup block
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. 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)
- Go to the [duckdns website]({{project_url}}), register your subdomain(s) and retrieve your token.
- Create a container with your subdomain(s) and token. If you own `user.duckdns.org`, you set `SUBDOMAINS=user`. You would NOT set 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).
## Notice regarding automatic detection
Expand All @@ -71,7 +70,7 @@ app_setup_block: |
# changelog
changelogs:
- { date: "30.03.24:", desc: "Added IP address to logging output when updating addresses." }
- { date: "30.03.24:", desc: "Added IP address to logging output when IP changes." }
- { date: "23.12.23:", desc: "Rebase to Alpine 3.19." }
- { date: "14.10.23:", desc: "Rework shell script for case insensitivity and update readme to be more clear." }
- { date: "13.10.23:", desc: "Add support for public IPv6 address update using Cloudflare." }
Expand Down

0 comments on commit c9fab86

Please sign in to comment.