Skip to content

dyndns

A dynamic DNS service to update domain IPs

Will be deprecated

The dyndns module might eventually be migrated to 'clanServices'*

See: clanServices

Categories

Uncategorized

To understand the possible options that can be set visit the documentation of ddns-updater

Usage via Inventory

This module cannot be used via the inventory interface.

Usage via Nix

This module can be also imported directly in your nixos configuration. Although it is recommended to use the inventory interface if available.

Some modules are considered 'low-level' or 'expert modules' and are not available via the inventory interface.

{config, lib, inputs, ...}: {
    imports = [ inputs.clan-core.clanModules.dyndns ];
    # ...
}

Module Options

The following options are available for this module.

clan.dyndns.period

Domain update period in minutes

Type: signed integer

Default:

5

Declared in: clanModules/dyndns

clan.dyndns.server.domain

Domain to serve the webservice on

Type: string

Declared in: clanModules/dyndns

clan.dyndns.server.enable

Whether to enable dyndns webserver.

Type: boolean

Default:

false
Example 
true

Declared in: clanModules/dyndns

clan.dyndns.server.port

Port to listen on

Type: signed integer

Default:

54805

Declared in: clanModules/dyndns

clan.dyndns.settings

Configuration for which domains to update

Type: attribute set of (submodule)

Default:

[ ]

Declared in: clanModules/dyndns

clan.dyndns.settings.<name>.domain

The top level domain to update.

Type: string

Example 
"example.com"

Declared in: clanModules/dyndns

clan.dyndns.settings.<name>.extraSettings

Extra settings for the provider. Provider specific settings: https://github.com/qdm12/ddns-updater#configuration

Type: attribute set of string

Default:

{ }

Declared in: clanModules/dyndns

clan.dyndns.settings.<name>.provider

The dyndns provider to use

Type: string

Example 
"namecheap"

Declared in: clanModules/dyndns

clan.dyndns.settings.<name>.secret_field_name

The field name for the secret

Type: one of "password", "token", "api_key", "secret_api_key"

Default:

"password"
Example 
[
  "password"
  "api_key"
]

Declared in: clanModules/dyndns