diff --git a/images/docker-duckdns/index.html b/images/docker-duckdns/index.html index 9a2f4bddb6..42de26d6a3 100644 --- a/images/docker-duckdns/index.html +++ b/images/docker-duckdns/index.html @@ -14,7 +14,7 @@ - UPDATE_IP=ipv4 #optional - LOG_FILE=false #optional volumes: - - /path/to/appdata/config:/config #optional + - /path/to/duckdns/config:/config #optional restart: unless-stopped

docker cli (click here for more info)

docker run -d \
   --name=duckdns \
@@ -26,10 +26,10 @@
   -e TOKEN=token \
   -e UPDATE_IP=ipv4 `#optional` \
   -e LOG_FILE=false `#optional` \
-  -v /path/to/appdata/config:/config `#optional` \
+  -v /path/to/duckdns/config:/config `#optional` \
   --restart unless-stopped \
   lscr.io/linuxserver/duckdns:latest
-

Parameters

Containers are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate <external>:<internal> respectively. For example, -p 8080:80 would expose port 80 from inside the container to be accessible from the host's IP on port 8080 outside the container.

Ports (-p)

Parameter Function

Networking (--net)

Parameter Function
--net=host Use host networking for IPv6 detection

Environment Variables (-e)

Env Function
PUID=1000 for UserID - see below for explanation
PGID=1000 for GroupID - see below for explanation
TZ=Etc/UTC specify a timezone to use, see this list.
SUBDOMAINS=subdomain1,subdomain2 multiple subdomains allowed, comma separated, no spaces, if your domain is user.duckdns.org you put user, not a sub-subdomain
TOKEN=token DuckDNS token
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. Omitting this variable uses DuckDNS for detection and only supports IPv4. both and ipv6 modes needs host networking.
LOG_FILE=false Set to true to log to file (also need to map /config).

Volume Mappings (-v)

Volume Function
/config Used in conjunction with logging to file.

Miscellaneous Options

Parameter Function

Environment variables from files (Docker secrets)

You can set any environment variable from a file by using a special prepend FILE__.

As an example:

-e FILE__MYVAR=/run/secrets/mysecretvariable
+

Parameters

Containers are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate <external>:<internal> respectively. For example, -p 8080:80 would expose port 80 from inside the container to be accessible from the host's IP on port 8080 outside the container.

Ports (-p)

Parameter Function

Networking (--net)

Parameter Function
--net=host Use host networking for IPv6 detection

Environment Variables (-e)

Env Function
PUID=1000 for UserID - see below for explanation
PGID=1000 for GroupID - see below for explanation
TZ=Etc/UTC specify a timezone to use, see this list.
SUBDOMAINS=subdomain1,subdomain2 multiple subdomains allowed, comma separated, no spaces, if your domain is user.duckdns.org you put user, not a sub-subdomain
TOKEN=token DuckDNS token
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. Omitting this variable uses DuckDNS for detection and only supports IPv4. both and ipv6 modes needs host networking.
LOG_FILE=false Set to true to log to file (also need to map /config).

Volume Mappings (-v)

Volume Function
/config Persistent config files

Miscellaneous Options

Parameter Function

Environment variables from files (Docker secrets)

You can set any environment variable from a file by using a special prepend FILE__.

As an example:

-e FILE__MYVAR=/run/secrets/mysecretvariable
 

Will set the environment variable MYVAR based on the contents of the /run/secrets/mysecretvariable file.

Umask for running applications

For all of our images we provide the ability to override the default umask settings for services started within the containers using the optional -e UMASK=022 setting. Keep in mind umask is not chmod it subtracts from permissions based on it's value it does not add. Please read up here before asking for support.

User / Group Identifiers

When using volumes (-v flags), permissions issues can arise between the host OS and the container, we avoid this issue by allowing you to specify the user PUID and group PGID.

Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.

In this instance PUID=1000 and PGID=1000, to find yours use id your_user as below:

id your_user
 

Example output:

uid=1000(your_user) gid=1000(your_user) groups=1000(your_user)
 

You only need to set the PUID and PGID variables if you are mounting the /config folder

Docker Mods

Docker Mods Docker Universal Mods

We publish various Docker Mods to enable additional functionality within the containers. The list of Mods available for this image (if any) as well as universal mods that can be applied to any one of our images can be accessed via the dynamic badges above.

Support Info