hetzner_ddns.1.man

.\" Manual for hetzner_ddns.
.TH "hetzner_ddns" 1 "2 August 2024" "hetzner_ddns 0.2.5" "Hetzner DDNS Manual"
.SH NAME
.B hetzner_ddns
\- Hetzner Dynamic DNS Daemon
.SH SYNOPSIS
.B hetzner_ddns [--daemon] [CONFIG]
.P
This program should be run as a system service.
.SH OPTIONS
.HP
.B -d, --daemon
.br
Detach from current shell and run as a deamon
.HP
.B -h, --help
.br
Print help and exit
.HP
.B -v, --version
.br
Print version and exit
.HP
.B CONFIG
.br
Use configuration file hetzner_ddns.\fICONFIG\fR.conf
.br
and log to file hetzner_ddns.\fICONFIG\fR.log
.SH USAGE
.SS Run on startup
service hetzner_ddns
.B enable
.SS Start
service hetzner_ddns
.B start
.SS Stop
service hetzner_ddns
.B stop
.SS Runtime messages log file
Runtime log is located at
.I /var/log/hetzner_ddns.log
.SS Multiple daemon instances \fR(systemd only)
systemctl <action> hetzner_ddns@\fICONFIG\fR
.SH CONFIGURATION
Configuration file is located at
.I /usr/local/etc/hetzner_ddns.conf
.HP
.B interval
<seconds>
.br
Seconds between updates / TTL value
.HP
.B key
<32 character key>
.br
Hetzner DNS API key
.HP
.B domain
<domain name>
.br
Top level domain name
.HP
.B records
<hostname>...
.br
Space separated host subdomains (
.B @
for the domain itself )