Add README
This commit is contained in:
+42
@@ -0,0 +1,42 @@
|
|||||||
|
* R53
|
||||||
|
|
||||||
|
~r53~ is a dynamic DNS client for AWS Route 53. It queries the host's
|
||||||
|
public IPv4 and IPv6 addresses via OpenDNS (falling back to Google) and
|
||||||
|
upserts the corresponding =A= and =AAAA= records for each domain.
|
||||||
|
|
||||||
|
** Usage
|
||||||
|
|
||||||
|
#+begin_src shell
|
||||||
|
r53 -zone ZONEID [-ttl SECONDS] <domain>...
|
||||||
|
#+end_src
|
||||||
|
|
||||||
|
Flags:
|
||||||
|
|
||||||
|
- =-zone= — Route 53 hosted zone ID (required)
|
||||||
|
- =-ttl= — TTL of the DNS records in seconds (default: 300)
|
||||||
|
|
||||||
|
Arguments:
|
||||||
|
|
||||||
|
- =<domain>= — one or more domain names to update
|
||||||
|
|
||||||
|
~r53~ requires the =dig= command and AWS credentials from the SDK default
|
||||||
|
chain (environment, shared config, or IMDS).
|
||||||
|
|
||||||
|
On success the command writes nothing to =stdout=; it logs the Route 53
|
||||||
|
response for each domain to =stderr= at debug level.
|
||||||
|
|
||||||
|
** Examples
|
||||||
|
|
||||||
|
#+begin_src shell
|
||||||
|
$ r53 -zone Z1234567890EXAMPLE example.com www.example.com
|
||||||
|
|
||||||
|
$ r53 example.com
|
||||||
|
time=2026-10-24T03:08:42Z level=ERROR source=…/cmd/r53/main.go:38 \
|
||||||
|
msg=failed error="missing hosted zone id"
|
||||||
|
#+end_src
|
||||||
|
|
||||||
|
** Installation
|
||||||
|
|
||||||
|
#+begin_src shell
|
||||||
|
go install code.chimeric.al/dwrz/r53/cmd/r53@latest
|
||||||
|
#+end_src
|
||||||
Reference in New Issue
Block a user