netlify-ddns 0.3.4

A simple CLI tool for setting Netlify DNS records dynamically.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71

<h1 align="center">
    :globe_with_meridians:<br>
    netlify-ddns
</h1>
<div align="center">
    <strong>A CLI tool for setting Netlify DNS records dynamically.</strong>
</div>
<br>
<div align="center">
  <a href="https://github.com/lukehsiao/netlify-ddns-rs/actions/workflows/rust.yml">
    <img src="https://img.shields.io/github/actions/workflow/status/lukehsiao/netlify-ddns-rs/rust.yml" alt="Build Status"></a>
  <a href="https://crates.io/crates/netlify-ddns">
    <img src="https://img.shields.io/crates/v/netlify-ddns" alt="Version">
  </a>
  <a href="https://github.com/lukehsiao/netlify-ddns-rs/blob/main/LICENSE">
    <img src="https://img.shields.io/crates/l/netlify-ddns" alt="License">
  </a>
</div>
<br>

`netlify-ddns` is a simple command line tool for creating a DNS record for [Netlify's Managed DNS][netlify] service.
It is meant to be run as a cron job and queries third-parties (multiple, in case one is down) for your public IP, then updates or adds a DNS record using the Netlify API.

## Installation

Install using [cargo][cargo]:

```
cargo install netlify-ddns
```

## Usage

```
A simple CLI tool for setting Netlify DNS records dynamically.

Usage: netlify-ddns [OPTIONS] --domain <DOMAIN> --token <TOKEN>

Options:
  -d, --domain <DOMAIN>        The full domain for the DNS record
  -s, --subdomain <SUBDOMAIN>  The subdomain segment for the DNS record [default: www]
      --ttl <TTL>              The TTL value in seconds to set with the record [default: 3600]
  -i, --ip-type <IP_TYPE>      Whether an IPv6 "AAAA" or an IPv4 "A" record should be updated [default: ipv4] [possible values: ipv4, ipv6]
  -t, --token <TOKEN>          Your Netlify personal access token [env: NETLIFY_TOKEN=]
  -h, --help                   Print help information
  -V, --version                Print version information
```

## Example Cronjob

You could set a cronjob to update the `dev.example.com` hourly with a task like
the following.

```
0 * * * * netlify-ddns -d example.com -s dev --token=<your token>
```

## Related

* [oscartbeaumont/netlify-dynamic-dns] for a similar client written in [Go][go].
* [lytedev/netlify-ddns] for a simple shell script version.
* [skylerwlewis/netlify-ddns.sh] for another simple script version.
* [johnsmol/netlify-ddns] for version written in Python.

[cargo]: https://doc.rust-lang.org/cargo/getting-started/installation.html
[go]: https://golang.org/
[lytedev/netlify-ddns]: https://github.com/lytedev/netlify-ddns
[netlify]: https://www.netlify.com/docs/dns/
[oscartbeaumont/netlify-dynamic-dns]: https://github.com/oscartbeaumont/netlify-dynamic-dns
[skylerwlewis/netlify-ddns.sh]: https://gist.github.com/skylerwlewis/ba052db5fe26424255674931d43fc030
[johnsmol/netlify-ddns]: https://github.com/johnsmol/netlify-ddns