User Tools

Site Tools


doc:uci:ddns
This wiki is read only and for archival purposes only. >>>>>>>>>> Please use the new OpenWrt wiki at https://openwrt.org/ <<<<<<<<<<

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
doc:uci:ddns [2016/10/25 21:19]
chris5560 first new entries
doc:uci:ddns [2017/10/05 07:40] (current)
tmomas alte Version wiederhergestellt (2016/12/05 12:13)
Line 10: Line 10:
 :!: **Keep in mind, that //​ddns-scripts//​ are designed to support ONE host or IP protokoll version per section.**\\ :!: **Keep in mind, that //​ddns-scripts//​ are designed to support ONE host or IP protokoll version per section.**\\
 :!: **Including BB 14.07 //​ddns-scripts//​ only support update of IPv4 addresses.** :!: **Including BB 14.07 //​ddns-scripts//​ only support update of IPv4 addresses.**
 +
 +:!: **Starting ddns-scripts 2.7.6 (trunk) option naming will change for better functional grouping.**\\
 +Updating ddns-scripts to newer versions will do the renaming inside existing config files during update automatically.\\
 +Additionally some options will be also available globally [[doc:​uci:​ddns#​section_ddns|(see below)]] so they need not be defined for every service section.\\
 +Options defined inside service section overwrite global section settings.
 +
 ===== Example ===== ===== Example =====
  
Line 50: Line 56:
 :!: ** You need to define a "​service"​ section for every DDNS provider and Host you want to feed.\\ :!: ** You need to define a "​service"​ section for every DDNS provider and Host you want to feed.\\
 :!: Same if you want to feed IPv4- and IPv6-address to your DDNS provider.** (Since CC 15.05)\\ :!: Same if you want to feed IPv4- and IPv6-address to your DDNS provider.** (Since CC 15.05)\\
-:!: **Starting ddns-scripts 2.8.x (DD trunk) option naming will change for better functional grouping.**\\ 
-Updating ddns-scripts to newer versions will do the renaming inside existing config files automatically.\\ 
-Additionally some options will be also available globally [[doc:​uci:​ddns#​section_ddns|(see below)]] so they need not be defined for every service section.\\ 
-Options defined inside service section overwrite global section settings. 
  
-^ Name (old) ^ Name (new) ^ Type ^ Required ^ Default ^ Description ^+ Name\\ (old)   Name\\ (new)  ^ Type ^ Required ^ Default ^ Description ^
 |  ''​enabled''​ | |  boolean ​ |  yes  |  '​0' ​ | disable(0) / enable(1) this service section. ​ | |  ''​enabled''​ | |  boolean ​ |  yes  |  '​0' ​ | disable(0) / enable(1) this service section. ​ |
 |  ''​interface''​ | |  network name  |  yes  |  //​(none)// ​ | The DDNS scripts use the Linux hotplug events system. When this specified network interface comes up, a related ifup hotplug event will cause DDNS script to start to monitor (and update) the external IP address of . Select the WAN interface that will have the external IP address to use in the DDNS registration. ​ | |  ''​interface''​ | |  network name  |  yes  |  //​(none)// ​ | The DDNS scripts use the Linux hotplug events system. When this specified network interface comes up, a related ifup hotplug event will cause DDNS script to start to monitor (and update) the external IP address of . Select the WAN interface that will have the external IP address to use in the DDNS registration. ​ |
Line 62: Line 64:
 |  ''​update_url''​ | |  string ​ |  yes(*) ​ |  //​(none)// ​ | Have a look at DDNS providers configuration help. Use the their URL here.\\ //**(*) Remove this option, if '''​option service_name'''​ is set.**// ​ | |  ''​update_url''​ | |  string ​ |  yes(*) ​ |  //​(none)// ​ | Have a look at DDNS providers configuration help. Use the their URL here.\\ //**(*) Remove this option, if '''​option service_name'''​ is set.**// ​ |
 |  ''​update_script''​ | |  string ​ |  no  |  //​(none)// ​ | **Since CC 15.05** ''/​path/​to/​update_script.sh''​\\ If your DDNS provider doesn'​t work with ddns-scripts,​ because there are additional parameters or other special thinks to be done, then you could write your own script to send updates to your DDNS provider.\\ Have a look into [[https://​github.com/​openwrt/​packages/​tree/​master/​net/​ddns-scripts/​samples|update_sample.sh]]\\ :!: Remove '''​option service_name'''​ and use either this option **OR** '''​option update_url'''​. ​ | |  ''​update_script''​ | |  string ​ |  no  |  //​(none)// ​ | **Since CC 15.05** ''/​path/​to/​update_script.sh''​\\ If your DDNS provider doesn'​t work with ddns-scripts,​ because there are additional parameters or other special thinks to be done, then you could write your own script to send updates to your DDNS provider.\\ Have a look into [[https://​github.com/​openwrt/​packages/​tree/​master/​net/​ddns-scripts/​samples|update_sample.sh]]\\ :!: Remove '''​option service_name'''​ and use either this option **OR** '''​option update_url'''​. ​ |
-|  ''​domain''​ | |  string ​ |  yes  |  //​(none)// ​ | The DNS name / Hostname to update\\ //(this name must already be registered with the DDNS provider)//​\\ :!: **If your DDNS provider don't need this information being send for update, put it in anyway. ''​ddns-scripts''​ use it to compare local IP with registered IP.**  |+|  ''​domain''​ | |  string ​ |  yes  |  //​(none)// ​ | The DNS name / Hostname to update\\ //(this name must already be registered with the DDNS provider)//​\\ :!: **If your DDNS provider don't need this information being send for update, put it in anyway. ''​ddns-scripts''​ use it to compare local IP with registered IP.**\\ :!: **Since DD** ''​ddns-scripts''​ use '''​option lookup_host'''​ (see below) to detect your registered IP.\\ So this option can be used for special multihost update configurations supported by some providers. ​  |
 |  ''​username''​ | |  string ​ |  yes(*) ​ |  //​(none)// ​ | Username of your DDNS providers account\\ Have a look at DDNS providers help, because some providers are using different information as "​username"​ for DDNS updates (i.e. hostname).\\ Look at [[doc:​howto:​ddns.client|DDNS client]] for additional information.\\ //**(*)If your DDNS provider don't need this information being send for update, put in an "​X"​ instead.**// ​ | |  ''​username''​ | |  string ​ |  yes(*) ​ |  //​(none)// ​ | Username of your DDNS providers account\\ Have a look at DDNS providers help, because some providers are using different information as "​username"​ for DDNS updates (i.e. hostname).\\ Look at [[doc:​howto:​ddns.client|DDNS client]] for additional information.\\ //**(*)If your DDNS provider don't need this information being send for update, put in an "​X"​ instead.**// ​ |
 |  ''​password''​ | |  string ​ |  yes(*) ​ |  //​(none)// ​ | Password of your DDNS providers account\\ Have a look at DDNS providers help, because some providers are using different information as "​password"​ for DDNS updates (i.e. tokenid).\\ Look at [[doc:​howto:​ddns.client|DDNS client]] for additional information.\\ //**(*)If your DDNS provider don't need this information being send for update, put in an "​X"​ instead.**// ​ | |  ''​password''​ | |  string ​ |  yes(*) ​ |  //​(none)// ​ | Password of your DDNS providers account\\ Have a look at DDNS providers help, because some providers are using different information as "​password"​ for DDNS updates (i.e. tokenid).\\ Look at [[doc:​howto:​ddns.client|DDNS client]] for additional information.\\ //**(*)If your DDNS provider don't need this information being send for update, put in an "​X"​ instead.**// ​ |
Line 86: Line 88:
 |  ''​force_ipversion''​ | |  boolean ​ |  no  |  '​0' ​ | **Since CC 15.05** disable(0) / enable(1) this option.\\ Normally the system decide by various settings mostly compiled into the software, if it prefers IPv4 or IPv6 communication. Some DDNS providers update their DDNS record by using the IP address you send the update from.\\ Then you need to force the usage of the IP version you want to update or you want to force it for other reasons depending on your environment.\\ :!: Needs Wget or cURL package and BIND host package to be installed !  | |  ''​force_ipversion''​ | |  boolean ​ |  no  |  '​0' ​ | **Since CC 15.05** disable(0) / enable(1) this option.\\ Normally the system decide by various settings mostly compiled into the software, if it prefers IPv4 or IPv6 communication. Some DDNS providers update their DDNS record by using the IP address you send the update from.\\ Then you need to force the usage of the IP version you want to update or you want to force it for other reasons depending on your environment.\\ :!: Needs Wget or cURL package and BIND host package to be installed !  |
 |  ''​bind_network''​ | |  string ​ |  no  |  //​(none)// ​ | **Since CC 15.05** Network to use for communication when detecting IP and sending updates.\\ :!: Needs Wget or cURL package to be installed !\\ Wget will bind to the IP and cURL to physical interface of given network. ​ | |  ''​bind_network''​ | |  string ​ |  no  |  //​(none)// ​ | **Since CC 15.05** Network to use for communication when detecting IP and sending updates.\\ :!: Needs Wget or cURL package to be installed !\\ Wget will bind to the IP and cURL to physical interface of given network. ​ |
 +|  ''​lookup_host''​ | |  string ​ |  yes  |  //​(none)// ​ | **Since DD** Option domain (see above) is no longer used to get the registered ip. Configure here the host you like to get registered ip for. This is useful if updating multiple hosts in one configuration section. |
 |  ''​rec_id''​ | |  string ​ |  no  |  //​(none)// ​ | **Since DD** If this is set and the service is CloudFlare, updates the specified record (useful when there are multiple records for the same domain). Determined automatically when not set (but in case of multiple records for the same domain one will be arbitrarily chosen). | |  ''​rec_id''​ | |  string ​ |  no  |  //​(none)// ​ | **Since DD** If this is set and the service is CloudFlare, updates the specified record (useful when there are multiple records for the same domain). Determined automatically when not set (but in case of multiple records for the same domain one will be arbitrarily chosen). |
 |  ''​is_glue''​ | |  boolean ​ |  no  |  '​0' ​ | **Since DD** This option is mandatory if the ddns record is a glue record and the registered ip should be compared against the glue record. This option requires bind host and does only work if the dns_server option is used. The dns_server value has to be the dns server where the glue record is defined.| |  ''​is_glue''​ | |  boolean ​ |  no  |  '​0' ​ | **Since DD** This option is mandatory if the ddns record is a glue record and the registered ip should be compared against the glue record. This option requires bind host and does only work if the dns_server option is used. The dns_server value has to be the dns server where the glue record is defined.|
Line 96: Line 99:
 :!: This settings are used by ''​ddns-scripts''​ and corresponding ''​luci-app-ddns''​. :!: This settings are used by ''​ddns-scripts''​ and corresponding ''​luci-app-ddns''​.
  
-^  Name (old) ^  Name (new) ^  Values ​ ^  Required ​ ^  Default ​ ^  Description ​ ^ +^  Name\\ (old)  ^  Name\\ (new)  ^  Values ​ ^  Required ​ ^  Default ​ ^  Description ​ ^ 
-|  ''​allow_local_ip''​ |  ''​ddns_privateip''​ |  boolean ​ |  no  |  '​0' ​ | disallow(0) / allow(1) to send Private/​Special IP's to the DDNS provider\\ blocked IPv4: 0/8, 10/8, 100.64/10, 127/8, 169.254/16, 172.16/12, 192.168/​16\\ blocked IPv6: ::/32, f000::/​4 ​ |+|  ''​allow_local_ip''​ |  ''​upd_privateip''​ |  boolean ​ |  no  |  '​0' ​ | disallow(0) / allow(1) to send Private/​Special IP's to the DDNS provider\\ blocked IPv4: 0/8, 10/8, 100.64/10, 127/8, 169.254/16, 172.16/12, 192.168/​16\\ blocked IPv6: ::/32, f000::/​4 ​ |
 |  ''​date_format''​ |  ''​ddns_dateformat''​ |  string ​ |  no  |  '%F %R' ​ | set date format to use for display date in logfiles and LuCI WebUI.\\ For supported codes [[http://​www.cplusplus.com/​reference/​ctime/​strftime/​|look here]]. ​ | |  ''​date_format''​ |  ''​ddns_dateformat''​ |  string ​ |  no  |  '%F %R' ​ | set date format to use for display date in logfiles and LuCI WebUI.\\ For supported codes [[http://​www.cplusplus.com/​reference/​ctime/​strftime/​|look here]]. ​ |
 |  ''​run_dir''​ |  ''​ddns_rundir''​ |  string ​ |  no  |  '/​var/​run/​ddns' ​ | Set directory to use for '''​*.pid'''​ and '''​*.update'''​ files.\\ There are separate files for every running service section. ​ | |  ''​run_dir''​ |  ''​ddns_rundir''​ |  string ​ |  no  |  '/​var/​run/​ddns' ​ | Set directory to use for '''​*.pid'''​ and '''​*.update'''​ files.\\ There are separate files for every running service section. ​ |
doc/uci/ddns.1477423167.txt.bz2 · Last modified: 2016/10/25 21:19 by chris5560