tengel/petrified
1
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Fixing up a bunch of stuff

Browse source
This commit is contained in:
tengel 2024-03-20 09:32:36 -05:00
parent a8810cb66b
commit 2f823b1355
1 changed files with 40 additions and 24 deletions
Download patch file Download diff file Expand all files Collapse all files

64
README.md
View file

@ -5,9 +5,22 @@ GPLv3 - see LICENSE for details
## Introduction ## Introduction
Petrified is a bash client to update dynamic DNS at freedns.afraid.org; the goals Petrified is a bash client to update dynamic DNS at freedns.afraid.org;
are for simplicity, flexibility and configurability which using the minimal the goals are for simplicity, flexibility and configurability which using
system tools installed with most distributions. the minimal system tools installed with most distributions.
## Features
- Several configuration methods:
* /etc/petrified.conf
* ~/.petrifiedrc
* -c (config) on the commandline
- IPv4 and IPv6 support
- PID usage to prevent race conditions or stacked crons
- Logging via journald, syslog, stdout and a logfile simultaneously
- Local IP reporting for use with internal DNS entries
- Caching of the last IP to reduce upstream impact
- Usable via cron, NetworkManager dispatcher, commandline, etc.
## Dependencies ## Dependencies
@ -25,26 +38,12 @@ system tools installed with most distributions.
| curl | curl | | curl | curl |
## Features
- Several configuration methods:
* /etc/petrified.conf
* ~/.petrifiedrc
* -c (config) on the commandline
- IPv4 and IPv6 support
- PID usage to prevent race conditions
- Logging via journald, syslog, stdout and a logfile
- Local IP reporting for use on internal machines
- Caching of the last IP to reduce upstream impact
- Usable via cron, NetworkManager dispatcher, commandline, etc.
## Configuration ## Configuration
Copy the default configuration file to */etc/petrified.conf*, *~/.petrifiedrc* or Copy the default configuration file to */etc/petrified.conf* for global
another location as desired. At a minimum the **DDNS_KEY** variable must be use, *~/.petrifiedrc* for user-level use, or another location as desired.
configured for basic usage as root, all other variables are preconfigured for At a minimum the **DDNS_KEY** variable must be configured for basic usage;
system level (root) usage. all other variables are preconfigured for system level (root) usage.
If implementing at the user level, be sure and set the various file location If implementing at the user level, be sure and set the various file location
options to a directory that is writable by the user; the default config is options to a directory that is writable by the user; the default config is
@ -54,8 +53,25 @@ fully documented and should make sense.
Usage is simple - just run **petrified** and check your log(s). Usage is simple - just run **petrified** and check your log(s).
To use a custom configuration file, the **-c (config)** parameter is supported; To use a custom configuration file, the **-c (config)** parameter is
note that using this option will *not* read the global/local configuration files supported; note that using this option will *not* read the global/local
and only use the variables from this custom file. configuration files and only use the variables from this custom file.
## Acknowledgements
### Author
Troy Engel <troyengel@gmail.com>
Prior to writing this software, several contributions were made to:
* afraid-dyndns
* fdnsc
The original version of petrified was influenced by these two software
package's concepts, however actual code was not used.
### Contributors
### Maintainers