How to use yaddns

How to use yaddns

This documentation is for yaddns 1.1

Man

There 2 man pages:

• yaddns (1)
• yaddns.conf (5)

You can found it in doc/ directory in the source. This is a good place to have the most updated documentation !

How it works

When you launch yaddns, it tries to get wan ip address and contact the dynamic ip address service for synchronization.

Yaddns can be launch at boot time likes daemon :

• it grabs wan ip address (asking wan interface or using http service called "myip" in yaddns) ;
• it detects wan ip address change and update automaticaly the service ;

myip

Myip feature allow to execute yaddns on computer which doesn't have the wan interface. It retrieve wan ip address calling html page on remote http server which has in his content the wan ip address of the client.

yaddns.conf

# general config
wanifname = "ppp0"
mode = "direct"

myip_host = "www.regfish.com"
myip_path = "/show_myip.php"
myip_port = 80
myip_upint = 60

# accounts
account {
        name = "dyndns test"
        service = "dyndns"
        username = "test"
        password = "test"
        hostname = "test.dyndns.org"
}

General section

• wanifname : give the name of interface which is connected to wan (and so, have the wan ip address)
• mode [direct,indirect] : if mode is direct, yaddns uses wanifname to retrieve wan ip address. Otherwise, if mode is indirect, it uses "myip service" to grab wan ip address
• myip_host : the hostname of http server
• myip_path : the page on http server where find wan ip address
• myip_port : the port of http server
• myip_upint : time interval between each grab request

Account

• name : name of this account (must be unique in the config file)
• service [changeip,dyndns,dyndnsit,no-ip,ovh,sitelutions] : the name of service which is used for this account
• username : the service username
• password : the service password
• hostname : the service hostname

Start

You can start yaddns without root permission (and it's recommended).

To launch yaddns likes a daemon program, type this :

$ yaddns -D

To get information about yaddns status and service synchronization or errors, view log messages in syslog :

# tail -f /var/log/messages

If you don't start yaddns with daemon option, the log messages appears directly in console.