Navigation :

Using dynamic DNS services

Follow these instructions if the Internet connection you use with Web Radio Control uses a dynamic (changing) IP address and you don’t have an existing dynamic DNS domain name configured. This update routine for keeping a dynamic DNS domain name IP address up-to-date is not required if your Internet connection has a static IP address.

If you are already using a dynamic DNS service, you most likely have an update routine for the IP address active and working. Follow these instructions only if you wish to use the internal update routine of Web Radio Control to keep your dynamic DNS domain name IP address up-to-date. In this case you will need to disable the existing update routine.

Web Radio Control provides support for updating the IP address of a domain name registered via a dynamic DNS service.

Supported dynamic DNS services

In order to configure the built-in dynamic DNS update routine you will need to know the following details: the name of the dynamic DNS service you use, the user name and the password of your account for the service and the domain name you wish to use. If you are not using any dynamic DNS service yet, please read instructions about choosing one of the supported dynamic DNS services on page network setup.

Add the following definitions to the end of the configuration file:

dynamicDns:
  client:
    enabled: true
    ipv4: true
    ipv6: false
    type: "TYPE"
    username: "USERNAME"
    password: "PASSWORD"

Replace the placeholders (e.g. TYPE) in the configuration file example above. The placeholders that need to be replaced are listed below. Please pay attention to preserve any double quotes and spaces around the placeholders.

The configuration file format is called YAML, which is sensitive to the number of spaces in the beginning of each line. Please make sure to not change the number of spaces!

ipv4 - Web Radio Control uses IPv4 addresses by default (value true). If you do not wish to use IPv4 addresses with the configured dynamic DNS service, turn off IPv4 address updates by setting this value false.
ipv6 - If you wish to use IPv6 addresses with the configured dynamic DNS service, turn on IPv6 address update by setting this value to true. It is also possible to use both IPv4 and IPv6 addresses by setting both ipv4 and ipv6 values to true.
TYPE - Name of the dynamic DNS service to be used, one of: dy.fi, no-ip, dynu, dyn, freedns, duckdns

If the dynamic DNS service you use is not listed in the above list of supported services, you can set type to custom and follow the instructions below regarding use of other dynamic DNS services.
USERNAME - User name of your account for the dynamic DNS service
PASSWORD - Password of your account for the dynamic DNS service

Use of other dynamic DNS services

Follow these instructions only if you are using a dynamic DNS service that is not one of the supported ones listed above.

Most dynamic DNS services use an HTTP URL address for performing IP address updates for the dynamic DNS domain name. Please find the documentation for this address and the required HTTP request parameters from the dynamic DNS service provider.

Add the following definitions to the end of the configuration file:

dynamicDns:
  client:
    enabled: true
    type: "custom"
    username: "USERNAME"
    password: "PASSWORD"
    customUrlTemplate: "URL_TEMPLATE"
    customAddressChangedResponseText: "ADDRESS_CHANGED_RESPONSE"
    customAddressNotChangedResponseText: "ADDRESS_NOT_CHANGED_RESPONSE"

USERNAME - User name of your account for the dynamic DNS service
PASSWORD - Password of your account for the dynamic DNS service
URL_TEMPLATE - HTTP URL address in the dynamic DNS service provider API for updating IP addresses. This URL should be available in the API documentation of the dynamic DNS service provider. NOTE: Please use a URL beginning with HTTPS (if the provider supports it), so that the communication with the dynamic DNS service is encrypted and your account password will be kept safe.

Web Radio Control uses HTTP Basic authentication to include the user name and the password in the HTTP request.

Example: https://dynupdate.no-ip.com/nic/update?hostname={{.Domain}}&myip={{.Address}}

The following placeholders are available in the URL template and they are automatically replaced by Web Radio Control:
- {{.Domain}} - The domain name in Web Radio Control configuration (publicHostname)
- {{.Address}} - The public IP address detected by Web Radio Control (only IPv4 supported at the moment)
- {{.Username}} - The user name defined in the placeholder USERNAME
- {{.Password}} - The password defined in the placeholder PASSWORD
ADDRESS_CHANGED_RESPONSE - Optional text string, which must be present in the HTTP response received from the dynamic DNS provider when the HTTP request to the dynamic DNS service resulted in an update of the IP address for the domain name. This information is used to control IP address update time intervals, so that the updates would be done only when they are really required (and not too often). The value of this setting can be left empty if the dynamic DNS service provider does not document the HTTP responses.
ADDRESS_NOT_CHANGED_RESPONSE - Optional text string, which must be present in the HTTP response received from the dynamic DNS provider when the HTTP request to the dynamic DNS service did not result in an update of the IP address for the domain name. This information is used to control IP address update time intervals, so that the updates would be done only when they are really required (and not too often). The value of this setting can be left empty if the dynamic DNS service provider does not document the HTTP responses.