Fabio/ddclient
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Fix formatting especially with code examples, apply linter suggestions

Browse source
This commit is contained in:
Sandro Jäckel 2020-05-27 03:27:03 +02:00
parent 42c21391f3
commit 4f0226ef05
No known key found for this signature in database
GPG key ID: 3AF5A43A3EECC2E5
1 changed files with 36 additions and 36 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

64
README.md
View file

@ -34,14 +34,14 @@ Dynamic DNS services currently supported include:
DDclient now supports many of cable/dsl broadband routers. DDclient now supports many of cable/dsl broadband routers.
Comments, suggestions and requests: use the issues on Comments, suggestions and requests: use the issues on https://github.com/ddclient/ddclient/issues/new
https://github.com/ddclient/ddclient/issues/new
The code was originally written by Paul Burry and is now hosted and maintained The code was originally written by Paul Burry and is now hosted and maintained
through github.com. Please check out http://ddclient.net through github.com. Please check out http://ddclient.net
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
## REQUIREMENTS:
## REQUIREMENTS
- one or more accounts from one of the dynamic DNS services - one or more accounts from one of the dynamic DNS services
@ -131,25 +131,19 @@ start the first time by hand
If you are not using daemon-mode, configure cron and dhcp or ppp as described below. If you are not using daemon-mode, configure cron and dhcp or ppp as described below.
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
## TROUBLESHOOTING:
1. enable debugging and verbose messages. ## TROUBLESHOOTING
``$ ddclient -daemon=0 -debug -verbose -noquiet``
1. enable debugging and verbose messages: ``$ ddclient -daemon=0 -debug -verbose -noquiet``
2. Do you need to specify a proxy? 2. Do you need to specify a proxy?
If so, just add a If so, just add a ``proxy=your.isp.proxy`` to the ddclient.conf file.
``proxy=your.isp.proxy``
to the ddclient.conf file.
3. Define the IP address of your router with ``fw=xxx.xxx.xxx.xxx`` in 3. Define the IP address of your router with ``fw=xxx.xxx.xxx.xxx`` in
``/etc/ddclient/ddclient.conf`` and then try ``/etc/ddclient/ddclient.conf`` and then try ``$ ddclient -daemon=0 -query`` to see if the router status web page can be understood.
``$ ddclient -daemon=0 -query``
to see if the router status web page can be understood.
4. Need support for another router/firewall? 4. Need support for another router/firewall?
Define the router status page yourself with: Define the router status page yourself with: ``fw=url-to-your-router``'s-status-page ``fw-skip=any-string-preceding-your-IP-address``
``fw=url-to-your-router``'s-status-page
``fw-skip=any-string-preceding-your-IP-address``
ddclient does something like this to provide builtin support for ddclient does something like this to provide builtin support for
common routers. common routers.
@ -158,24 +152,26 @@ If you are not using daemon-mode, configure cron and dhcp or ppp as described be
fw=192.168.1.1/Status.htm fw=192.168.1.1/Status.htm
fw-skip=WAN.*?IP Address fw-skip=WAN.*?IP Address
OR OR
Send me the output from: Send me the output from:
$ ddclient -geturl {fw-ip-status-url} [-login login [-password password]] ``$ ddclient -geturl {fw-ip-status-url} [-login login [-password password]]``
and I'll add it to the next release! and I'll add it to the next release!
ie. for my fw/router I used: ie. for my fw/router I used: ``$ ddclient -geturl 192.168.1.254/status.htm``
$ ddclient -geturl 192.168.1.254/status.htm
5. Some broadband routers require the use of a password when ddclient 5. Some broadband routers require the use of a password when ddclient
accesses its status page to determine the router's WAN IP address. accesses its status page to determine the router's WAN IP address.
If this is the case for your router, add If this is the case for your router, add
fw-login=your-router-login fw-login=your-router-login
fw-password=your-router-password fw-password=your-router-password
to the beginning of your ddclient.conf file.
Note that some routers use either 'root' or 'admin' as their login to the beginning of your ddclient.conf file.
while some others accept anything. Note that some routers use either 'root' or 'admin' as their login
while some others accept anything.
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
## USING DDCLIENT WITH ppp ## USING DDCLIENT WITH ppp
If you are using a ppp connection, you can easily update your DynDNS If you are using a ppp connection, you can easily update your DynDNS
@ -188,6 +184,7 @@ Alternatively, you may just configure ddclient to operate as a daemon
and monitor your ppp interface. and monitor your ppp interface.
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
## USING DDCLIENT WITH cron ## USING DDCLIENT WITH cron
If you have not configured ddclient to use daemon-mode, you'll need to If you have not configured ddclient to use daemon-mode, you'll need to
@ -199,22 +196,25 @@ not become stale.
vi /etc/cron.d/ddclient vi /etc/cron.d/ddclient
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
## USING DDCLIENT WITH dhcpcd-1.3.17 ## USING DDCLIENT WITH dhcpcd-1.3.17
If you are using dhcpcd-1.3.17 or thereabouts, you can easily update If you are using dhcpcd-1.3.17 or thereabouts, you can easily update
your DynDNS entry automatically every time your lease is obtained your DynDNS entry automatically every time your lease is obtained
or renewed by creating an executable file named: or renewed by creating an executable file named:
/etc/dhcpc/dhcpcd-{your-interface}.exe ``/etc/dhcpc/dhcpcd-{your-interface}.exe``
ie.: ie.:
cp sample-etc_dhcpc_dhcpcd-eth0.exe /etc/dhcpc/dhcpcd-{your-interface}.exe ``cp sample-etc_dhcpc_dhcpcd-eth0.exe /etc/dhcpc/dhcpcd-{your-interface}.exe``
In my case, it is named dhcpcd-eth0.exe and contains the lines: In my case, it is named dhcpcd-eth0.exe and contains the lines:
#!/bin/sh ```shell
PATH=/usr/sbin:/root/bin:${PATH} #!/bin/sh
logger -t dhcpcd IP address changed to $1 PATH=/usr/sbin:/root/bin:${PATH}
ddclient -proxy fasthttp.sympatico.ca -wildcard -ip $1 | logger -t ddclient logger -t dhcpcd IP address changed to $1
exit 0 ddclient -proxy fasthttp.sympatico.ca -wildcard -ip $1 | logger -t ddclient
exit 0
```
Other DHCP clients may have another method of calling out to programs Other DHCP clients may have another method of calling out to programs
for updating DNS entries. for updating DNS entries.
@ -228,11 +228,11 @@ and monitor your ethernet interface.
If you are using the ISC DHCP client (dhclient), you can update If you are using the ISC DHCP client (dhclient), you can update
your DynDNS entry automatically every time your lease is obtained your DynDNS entry automatically every time your lease is obtained
or renewed by creating an executable file named: or renewed by creating an executable file named:
/etc/dhclient-exit-hooks ``/etc/dhclient-exit-hooks``
ie.: ie.:
cp sample-etc_dhclient-exit-hooks /etc/dhclient-exit-hooks ``cp sample-etc_dhclient-exit-hooks /etc/dhclient-exit-hooks``
Edit /etc/dhclient-exit-hooks to change any options required. Edit ``/etc/dhclient-exit-hooks`` to change any options required.
Alternatively, you may just configure ddclient to operate as a daemon Alternatively, you may just configure ddclient to operate as a daemon
and monitor your ethernet interface. and monitor your ethernet interface.