starred/ddns-updater

mirror of https://github.com/qdm12/ddns-updater.git synced 2026-08-03 19:09:43 -04:00

Files

Quentin McGaw bfdae74925 docs: add contributing document with example provider

- add example provider in code and docs markdown file
- merge contributing guides together
- add contributing section on adding a new provider

2024-02-29 09:25:54 +00:00

1.0 KiB

Raw Blame History

Example.com

Configuration

Example

{
  "settings": [
    {
      "provider": "example",
      "domain": "domain.com",
      "host": "@",
      "username": "username",
      "password": "password",
      "ip_version": "ipv4",
      "ipv6_suffix": ""
    }
  ]
}

Compulsory parameters

"domain"
"host" is your host and can be a subdomain or "@" or the wildcard "*"
"username"
"password"

Optional parameters

"ip_version" can be ipv4 (A records), or ipv6 (AAAA records) or ipv4 or ipv6 (update one of the two, depending on the public ip found). It defaults to ipv4 or ipv6.
"ipv6_suffix" is the IPv6 interface identifiersuffix to use. It can be for example 0:0:0:0:72ad:8fbb:a54e:bedd/64. If left empty, it defaults to no suffix and the raw public IPv6 address obtained is used in the record updating.

Domain setup