Fix formatting especially with code examples, apply linter suggestions

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

View file

@ -34,14 +34,14 @@ Dynamic DNS services currently supported include:
DDclient now supports many of cable/dsl broadband routers.
Comments, suggestions and requests: use the issues on
https://github.com/ddclient/ddclient/issues/new
Comments, suggestions and requests: use the issues on https://github.com/ddclient/ddclient/issues/new
The code was originally written by Paul Burry and is now hosted and maintained
through github.com. Please check out http://ddclient.net
-------------------------------------------------------------------------------
## REQUIREMENTS:
## REQUIREMENTS
- one or more accounts from one of the dynamic DNS services
@ -131,51 +131,47 @@ start the first time by hand
If you are not using daemon-mode, configure cron and dhcp or ppp as described below.
-------------------------------------------------------------------------------
## TROUBLESHOOTING:
1. enable debugging and verbose messages.
``$ ddclient -daemon=0 -debug -verbose -noquiet``
## TROUBLESHOOTING
1. enable debugging and verbose messages: ``$ ddclient -daemon=0 -debug -verbose -noquiet``
2. Do you need to specify a proxy?
If so, just add a
``proxy=your.isp.proxy``
to the ddclient.conf file.
If so, just add a ``proxy=your.isp.proxy`` to the ddclient.conf file.
3. Define the IP address of your router with ``fw=xxx.xxx.xxx.xxx`` in
``/etc/ddclient/ddclient.conf`` and then try
``$ ddclient -daemon=0 -query``
to see if the router status web page can be understood.
``/etc/ddclient/ddclient.conf`` and then try ``$ ddclient -daemon=0 -query`` to see if the router status web page can be understood.
4. Need support for another router/firewall?
Define the router status page yourself with:
``fw=url-to-your-router``'s-status-page
``fw-skip=any-string-preceding-your-IP-address``
Define the router status page yourself with: ``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
common routers.
For example, the Linksys routers could have been added with:
fw=192.168.1.1/Status.htm
fw-skip=WAN.*?IP Address
fw=192.168.1.1/Status.htm
fw-skip=WAN.*?IP Address
OR
OR
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!
ie. for my fw/router I used:
$ ddclient -geturl 192.168.1.254/status.htm
ie. for my fw/router I used: ``$ ddclient -geturl 192.168.1.254/status.htm``
5. Some broadband routers require the use of a password when ddclient
accesses its status page to determine the router's WAN IP address.
If this is the case for your router, add
fw-login=your-router-login
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
while some others accept anything.
fw-login=your-router-login
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
while some others accept anything.
-------------------------------------------------------------------------------
## USING DDCLIENT WITH ppp
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.
-------------------------------------------------------------------------------
## USING DDCLIENT WITH cron
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
-------------------------------------------------------------------------------
## USING DDCLIENT WITH dhcpcd-1.3.17
If you are using dhcpcd-1.3.17 or thereabouts, you can easily update
your DynDNS entry automatically every time your lease is obtained
or renewed by creating an executable file named:
/etc/dhcpc/dhcpcd-{your-interface}.exe
``/etc/dhcpc/dhcpcd-{your-interface}.exe``
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:
#!/bin/sh
PATH=/usr/sbin:/root/bin:${PATH}
logger -t dhcpcd IP address changed to $1
ddclient -proxy fasthttp.sympatico.ca -wildcard -ip $1 | logger -t ddclient
exit 0
```shell
#!/bin/sh
PATH=/usr/sbin:/root/bin:${PATH}
logger -t dhcpcd IP address changed to $1
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
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
your DynDNS entry automatically every time your lease is obtained
or renewed by creating an executable file named:
/etc/dhclient-exit-hooks
``/etc/dhclient-exit-hooks``
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
and monitor your ethernet interface.