Skip to content

Commit 1813ee2

Browse files
Bot Updating Templated Files
1 parent e07309e commit 1813ee2

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,13 @@ The architectures supported by this image are:
6363
- 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
6464
- It will update your IP with the DuckDNS service every 5 minutes (with a random jitter)
6565

66+
## Notice regarding automatic detection
67+
68+
Using the `UPDATE_IP` variable whatever its value (`ipv4`, `ipv6` or `both`) uses external *Cloudflare whoami* service to detect public IP addresses.
69+
**Be aware that using this variable will query a third-party service other than DuckDNS.**
70+
71+
Omitting the `UPDATE_IP` variable uses DuckDNS for detection and only supports IPv4.
72+
6673
## Usage
6774

6875
To help you get started creating a container from this image you can either use docker-compose or the docker cli.
@@ -76,12 +83,14 @@ services:
7683
duckdns:
7784
image: lscr.io/linuxserver/duckdns:latest
7885
container_name: duckdns
86+
network_mode: host #optional
7987
environment:
8088
- PUID=1000 #optional
8189
- PGID=1000 #optional
8290
- TZ=Etc/UTC #optional
8391
- SUBDOMAINS=subdomain1,subdomain2
8492
- TOKEN=token
93+
- UPDATE_IP=ipv4 #optional
8594
- LOG_FILE=false #optional
8695
volumes:
8796
- /path/to/appdata/config:/config #optional
@@ -93,11 +102,13 @@ services:
93102
```bash
94103
docker run -d \
95104
--name=duckdns \
105+
--net=host `#optional` \
96106
-e PUID=1000 `#optional` \
97107
-e PGID=1000 `#optional` \
98108
-e TZ=Etc/UTC `#optional` \
99109
-e SUBDOMAINS=subdomain1,subdomain2 \
100110
-e TOKEN=token \
111+
-e UPDATE_IP=ipv4 `#optional` \
101112
-e LOG_FILE=false `#optional` \
102113
-v /path/to/appdata/config:/config `#optional` \
103114
--restart unless-stopped \
@@ -110,11 +121,13 @@ Containers are configured using parameters passed at runtime (such as those abov
110121

111122
| Parameter | Function |
112123
| :----: | --- |
124+
| `--net=host` | Use host networking for IPv6 detection |
113125
| `-e PUID=1000` | for UserID - see below for explanation |
114126
| `-e PGID=1000` | for GroupID - see below for explanation |
115127
| `-e TZ=Etc/UTC` | specify a timezone to use, see this [list](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List). |
116128
| `-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 |
117129
| `-e TOKEN=token` | DuckDNS token |
130+
| `-e UPDATE_IP=ipv4` | Set to `ipv6` or `ipv4` to update **only** your public IPv4/6 address. Set to `both` to update IPv6 and IPv4 address. This variable makes use of a [third-party service](#notice-regarding-automatic-detection). Omitting this variable uses DuckDNS for detection and only supports IPv4. `both` and `ipv6` modes needs [host networking](#networking-net). |
118131
| `-e LOG_FILE=false` | Set to `true` to log to file (also need to map /config). |
119132
| `-v /config` | Used in conjunction with logging to file. |
120133

@@ -297,6 +310,7 @@ Once registered you can define the dockerfile to use with `-f Dockerfile.aarch64
297310
## Versions
298311

299312
* **14.10.23:** - Rework shell script for case insensitivity and update readme to be more clear.
313+
* **13.10.23:** - Add support for public IPv6 address update using Cloudflare.
300314
* **25.05.23:** - Rebase to Alpine 3.18, deprecate armhf.
301315
* **02.03.23:** - Rework shell scripts and cron logic.
302316
* **13.02.23:** - Rebase to alpine 3.17.

0 commit comments

Comments
 (0)