ddns.config_sample (11842B)
1 # 2 # 3 # Here you find a description on every parameter supported 4 # and used by ddns-scripts and corresponding LuCI application 5 # 6 # Inside your ddns configuration file (/etc/config/ddns) 7 # you might not find some of below described options. 8 # This is because you don't need to define options 9 # if using there defaults. The LuCI application will delete 10 # options that configured to there default values. 11 # 12 # If you have a working ddns configuration from old ddns-scripts (Version 1.x) 13 # everything will function the same with new scripts 14 # without any changes to the configuration. 15 # 16 # If you like to use this file for your configuration then 17 # use a copy, because the used software to modify the 18 # configuration files will throw away all empty lines 19 # and those starting with # (comments). 20 # 21 22 ##################################################################### 23 # Global application settings 24 # 25 config ddns "global" 26 27 ########### 28 # set date format to use for display date in logfiles 29 # and LuCI web application. 30 # For codes see man pages of date command. 31 # default: "%F %R" (ISO 8601 format) 32 # option ddns_dateformat "%F %R" 33 34 ########### 35 # set run directory to use for .pid and .update files 36 # there will be a separate file for every running service section 37 # default: "/var/run/ddns" 38 # option ddns_rundir "/var/run/ddns" 39 40 ########### 41 # set log directory to use for .log files 42 # there will be a separate file for every running service section 43 # default: "/var/log/ddns" 44 # option ddns_logdir "/var/log/ddns" 45 46 ########### 47 # set number of lines stored in .log file before auto truncated 48 # default: "250" lines 49 # option ddns_loglines "250" 50 51 ########### 52 # Whether to allow to send Private/Special IP's to the DDNS provider 53 # IPv4: 0.x, 10.x, 127.x, 172.16.x-172.31.x, 192.168.x 54 # IPv6: ::, Fxxx: 55 # default: "0" disabled 56 # option upd_privateip "0" 57 58 ##################################################################### 59 # DDNS service settings 60 # 61 # for each service you want to serve you need a separate configuration 62 # if you need IPv4 and IPv6 you need to setup 2 separate configurations 63 # with different names. (i.e. "myddns_ipv4" and "myddns_ipv6") 64 # do not use white-spaces or dashes "-" or "@" ":" "!" or 65 # other special characters inside name. 66 config service "myddns" 67 68 ########### Basic settings ######################## 69 70 ########### 71 # enable/disable this service section 72 # default: "0" disabled 73 option enabled "0" 74 75 ########### 76 # detecting/sending IPv4 or IPv6 address to the DDNS provider 77 # set to "1" if you want to use IPv6 78 # default: "0" use IPv4 79 option use_ipv6 "0" 80 81 ########### 82 # defines the network as defined in /etc/config/network 83 # to be monitored for up/down events to start via hotplug 84 default: "wan" for IPv4 85 default: "wan6" for IPv6 86 option interface "wan" 87 88 ########### 89 # Next you need to specify the name of the service you are 90 # connecting to "eg. dyndns.org". The format of the update 91 # urls for several different dynamic dns services is specified 92 # in the "/usr/lib/ddns/services" file for IPv4 and in 93 # "/usr/lib/ddns/service_ipv6" file. This list is hardly complete 94 # as there are many, many different dynamic dns services. 95 # If your service is on the list you can merely specify it with the 96 # "service_name" option. Otherwise you will need to determine 97 # the format of the url to update with. You can either add an 98 # entry to the "/usr/lib/ddns/services" or "services_ipv6" file 99 # or specify this with the "update_url" option. 100 # If your ddns provider doesn't work with ddns-scripts because 101 # there are additional parameters or other special thinks to be done, 102 # then you could write your own script to send updates to your ddns provider. 103 # Have a look into /usr/lib/ddns/update_sample.sh 104 # The script is specified in "update_script" 105 # Either set "service_name" or one of "update_url" and "update_script" 106 # default: none 107 option service_name "dyndns.org" 108 109 # sample: 110 # "http://[USERNAME]:[PASSWORD]@members.dyndns.org/nic/update?hostname=[DOMAIN]&myip=[IP]" 111 # option update_url "" 112 113 # sample: 114 # "/usr/lib/ddns/update_sample.sh" 115 # option update_script "" 116 117 ########### 118 # Keep an eye on providers help pages. 119 # 120 # FQDN of ONE of your defined host at DDNS provider 121 # REQUIRED to verify what the current IP at DNS using nslookup/host command 122 # default: none 123 option lookup_host "" 124 125 # Your DNS name / replace [DOMAIN] in update_url 126 # default: none 127 option domain "" 128 129 # Username of your DDNS service account / replace [USERNAME] in update_url 130 # default: none 131 option username "" 132 133 # Password of your DDNS service account / replace [PASSWORD] in update url 134 # default: none 135 option password "" 136 137 ########### 138 # Optional parameters for use inside update_url 139 # 140 # parameter that will be urlencoded before replacement of [PARAMENC] inside update url 141 # default: none 142 option param_enc "" 143 144 # parameter that repace [PARAMOPT] inside update url 145 # default: none 146 option param_opt "" 147 148 ########### 149 # use HTTPS for secure communication with you DDNS provider 150 # personally found some providers having problems when not sending 151 # updates via HTTPS. You must not specify "https://" in update_url. 152 # It's modified by the scripts themselves 153 # Needs GNU Wget (with SSL support) or cURL to be installed. 154 # default: "0" do not use HTTPS 155 option use_https "0" 156 157 # if using HTTPS (see above) the transfer program tries to verify 158 # the providers server certificate. For verification there needs to be 159 # the counterpart on this machine. Specify the path or path/file where 160 # the transfer program can find them. (might need package CA-certificates) 161 # if you don't want to verify servers certificate (insecure) you should 162 # this parameter to "IGNORE" (in capital letters) 163 # default: (none) path where CA-certificate package is installed 164 option cacert "/etc/ssl/certs" 165 166 ########### 167 # for logging and control if everything work fine you can get information inside 168 # system log . Critical Errors are always send to system log. 169 # You can define which information you like to log 170 # 1 == info, notice, warning, errors 171 # 2 == notice, warning, errors 172 # 3 == warning, errors 173 # 4 == errors 174 # default: "0" off 175 option use_syslog "0" 176 177 ########### 178 # for logging and control if everything work fine you can get information inside 179 # log file. You find the file per default in /var/log/ddns/[sectionname].log 180 # The path can be modified for all log files in ddns.global section (see above) 181 # default: "1" on 182 option use_logfile "1" 183 184 ########### Advanced settings ##################### 185 186 ########### 187 # you need to specify how ddns-scripts should detect you current local ip. 188 # the ip_source could be set to "network", "web", "interface" or "script" 189 # the parameters below specifying the additional information needed for 190 # the corresponding ip_spource configuration 191 # default: "network" 192 193 # ip_source "network" additional uses option ip_network and detects the 194 # current local ip on network as defined in /etc/config/network 195 # default: "wan" using IPv4 196 # default: "wan6" using IPv6 197 option ip_source "network" 198 option ip_network "wan" 199 200 # ip_source "web" additional uses option ip_url and detects the current 201 # local ip from special web sides that response with the ip address of 202 # calling host. If you are behind a firewall/NAT this is the best option 203 # since none of the local networks or interfaces will have the external ip. 204 # default: "http://checkip.dyndns.com" using IPv4 205 # default: "http://checkipv6.dyndns.com" using IPv6 206 # option ip_source "web" 207 # option ip_url "http://checkip.dyndns.com" 208 209 # ip_source "interface" additional uses option ip_interface 210 # ip_source "interface" uses one of the locally installed physical interfaces 211 # to detect independent from network they configured to. 212 # default: none 213 # option ip_source "interface" 214 # option ip_interface "eth1" 215 216 # ip_source "script" additional uses option ip_script 217 # it's useful if you want to write your own script to detect the 218 # current local ip. put full path into ip_script option. 219 # The script must be executable. 220 # default: none 221 # option ip_source "script" 222 # option ip_script "" 223 224 ########### 225 # force_ipversion option will set the "-4" respectively "-6" parameter 226 # on command line of transfer and DNS lookup program. 227 # So the whole communication uses the selected IP version between both ends. 228 # needs GNU Wget or cURL installed for transfer and 229 # BIND's host for DNS lookup. 230 # default: "0" disabled 231 option force_ipversion "0" 232 233 ########### 234 # Normally the current (in the internet) registered ip is detected using the 235 # local defined name lookup policies (i.e. /etc/resolve.conf etc.) 236 # Specify here a DNS server to use instead of the defaults. 237 # you can use hostname or ip address 238 # i.e. "google-public-dns-a.google.com" 239 # default: none 240 # option dns_server "google-public-dns-a.google.com" 241 242 # By default every DNS call is made via UDP protocol 243 # Some internet provider offer modems that cache UDP DNS requests. 244 # They also redirect calls to external servers to local. 245 # To force the usage of TCP for DNS requests enable this option 246 # Needs BIND's host program be installed 247 # default: "0" disabled 248 # option force_dnstcp "0" 249 250 ########### 251 # If a Proxy is need to access HTTP/HTTPS pages on the WEB 252 # it can be configured here also for sending updates to the 253 # DDNS provider. If you configured use_https='1' above, you 254 # need to setup your HTTPS proxy here, otherwise your 255 # HTTP proxy. !!! You should not detect your current IP 256 # ip_source='web' (see above) because this request is also 257 # send via the configured proxy !!! 258 # Syntax: [user:password@]proxy:port !port is required ! 259 # IPv6 address must be in squared brackets "[...]" 260 # default: none 261 # option proxy '' 262 263 ########### 264 # In some very special configurations i.e. Multi WAN environment 265 # in a NAT cascade it might be necessary to define 266 # a network to use for communication. 267 # should use option ip_source "web" (see above) 268 # Needs GNU Wget (with SSL support) or cURL to be installed. 269 # GNU Wget will use IP address and cURL the physical device 270 # of the given network 271 # default: none 272 # option bind_network "wan7" 273 274 ########### Timer settings ######################## 275 276 ########### 277 # defines the time interval to check if local IP has changed 278 # After the first start and first update send, the system will 279 # wait this time before verify if update was successful send. 280 # !!! checks below 5 minutes make no sense because the Internet 281 # needs about 5-10 minutes to sync an IP-change to all DNS servers !!! 282 # accepted unit entry’s: 'seconds' 'minutes' 'hours' 283 # minimum 5 minutes == 300 seconds 284 # default 10 minutes 285 option check_interval '10' 286 option check_unit 'minutes' 287 288 ########### 289 # force to send an update to service provider, if no change was detected. 290 # consult DDNS providers documentation if your DDNS entry might timeout. 291 # accepted unit entry’s: 'minutes' 'hours' 'days' 292 # minimum needs to be greater or equal check interval (see above) 293 # A special setting of '0' is allowed, which forces the script to run once. 294 # It sends an update, verify if update was accepted by DNS 295 # (retry if not) and finish. Useful if you want to start by your own (i.e. cron) 296 # default 3 days == 72 hours 297 option force_interval '72' 298 option force_unit 'hours' 299 300 ########### 301 # if error happen on detecting, sending or updating the 302 # script will retry the relevant action for retry_count times 303 # before stopping script execution. 304 # default: 5 305 option retry_count '5' 306 307 ########### 308 # if error happen on detecting, sending or updating the 309 # script will retry the relevant action. 310 # here you define the time to wait before retry is started 311 # accepted unit entry’s: 'seconds' 'minutes' 312 # default: 60 seconds 313 option retry_interval '60' 314 option retry_unit 'seconds'