92 lines
2.1 KiB
Groff
92 lines
2.1 KiB
Groff
|
.\" Automatically generated by Pandoc 2.19.2
|
||
|
|
.\"
|
||
|
|
.\" Define V font for inline verbatim, using C font in formats
|
||
|
|
.\" that render this, and otherwise B font.
|
||
|
|
.ie "\f[CB]x\f[]"x" \{\
|
||
|
|
. ftr V B
|
||
|
|
. ftr VI BI
|
||
|
|
. ftr VB B
|
||
|
|
. ftr VBI BI
|
||
|
|
.\}
|
||
|
|
.el \{\
|
||
|
|
. ftr V CR
|
||
|
|
. ftr VI CI
|
||
|
|
. ftr VB CB
|
||
|
|
. ftr VBI CBI
|
||
|
|
.\}
|
||
|
|
.TH "dynv6" "1" "January 2023" "dynv6" ""
|
||
|
|
.hy
|
||
|
|
.SH NAME
|
||
|
|
.PP
|
||
|
|
dynv6 - Updates dynv6 (an external service) and notifies about changes
|
||
|
|
of IP addresses.
|
||
|
|
Configuration is done in environment files.
|
||
|
|
.PD 0
|
||
|
|
.P
|
||
|
|
.PD
|
||
|
|
It\[cq]s part of \f[B]system-helpers\f[R].
|
||
|
|
.SH SYNOPSIS
|
||
|
|
.PP
|
||
|
|
\f[B]dynv6\f[R] [CONFIG_FILE (absolute path)]
|
||
|
|
.SH DESCRIPTION
|
||
|
|
.PP
|
||
|
|
\f[B]dynv6\f[R] updates dynv6 (an external service) and notifies about
|
||
|
|
changes of IP addresses.
|
||
|
|
It comes with systemd services.
|
||
|
|
.PP
|
||
|
|
If no \f[I]CONFIG_FILE\f[R] is provided, \f[B]dynv6\f[R] tries to read
|
||
|
|
from \f[I]$HOME/.dynv6.conf\f[R] and \f[I]/etc/dynv6.conf\f[R] for
|
||
|
|
configuration.
|
||
|
|
It will exit with a non-zero exit code if it cannot find an proper
|
||
|
|
configuration file.
|
||
|
|
.PP
|
||
|
|
The following are at least required for the script to work:
|
||
|
|
.PD 0
|
||
|
|
.P
|
||
|
|
.PD
|
||
|
|
- \f[B]DYNV6_MAIL_ENABLED\f[R] to enable or disable mail notification.
|
||
|
|
- \f[B]DYNV6_MAIL_ADDRESS\f[R] which requires \f[I]mail.rc\f[R] to be
|
||
|
|
configured and `\f[I]mailx\f[R]' command has be available.
|
||
|
|
.PD 0
|
||
|
|
.P
|
||
|
|
.PD
|
||
|
|
- \f[B]DYNV6_TOKEN\f[R] the dynv6 token.
|
||
|
|
.PD 0
|
||
|
|
.P
|
||
|
|
.PD
|
||
|
|
- \f[B]DYNV6_HOSTNAME\f[R] the dynv6 hostname.
|
||
|
|
.PD 0
|
||
|
|
.P
|
||
|
|
.PD
|
||
|
|
- \f[B]DYNV6_IPV4_ENABLED\f[R] enable or disable updating IPv4.
|
||
|
|
.PD 0
|
||
|
|
.P
|
||
|
|
.PD
|
||
|
|
- \f[B]DYNV6_IPV6_ENABLED\f[R] enable or disable updating IPv6.
|
||
|
|
.PD 0
|
||
|
|
.P
|
||
|
|
.PD
|
||
|
|
- \f[B]DYNV6_IPV6_INTERFACE\f[R] which interface to track, be sure that
|
||
|
|
Privacy Extensions are disabled.
|
||
|
|
.PD 0
|
||
|
|
.P
|
||
|
|
.PD
|
||
|
|
.PP
|
||
|
|
You can copy this script to \f[I]/usr/local/bin\f[R] and use create a
|
||
|
|
custom \f[B]CONFIG_FILE\f[R] as user.
|
||
|
|
.SH EXAMPLE
|
||
|
|
.PP
|
||
|
|
Create a \f[I]$HOME/.dynv6.conf\f[R] and add
|
||
|
|
\f[I]DYNV6_MAIL_ADDRESS=\[lq]alias\[at]domain.tld\[rq]\f[R].
|
||
|
|
Notifications will be delivered to alias\[at]domain.tld.
|
||
|
|
Examples can be found in \f[I]/usr/share/doc/dynv6\f[R].
|
||
|
|
.SH EXIT VALUES
|
||
|
|
.TP
|
||
|
|
\f[B]0\f[R]
|
||
|
|
Success
|
||
|
|
.TP
|
||
|
|
\f[B]1\f[R]
|
||
|
|
Error
|
||
|
|
.SH AUTHORS
|
||
|
|
Alexander Sch\[:a]ferdiek.
|