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:
troyengel 2014-09-07 17:36:17 -05:00
parent 2f7aaafce0
commit cf8ebba282
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
Petrified is a bash client to update dynamic DNS at freedns.afraid.org; the goals
are for simplicity, flexibility and configurability which using the minimal
system tools installed with most distributions.
Petrified is a bash client to update dynamic DNS at freedns.afraid.org;
the goals are for simplicity, flexibility and configurability which using
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
@ -25,26 +38,12 @@ system tools installed with most distributions.
| 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
Copy the default configuration file to */etc/petrified.conf*, *~/.petrifiedrc* or
another location as desired. At a minimum the **DDNS_KEY** variable must be
configured for basic usage as root, all other variables are preconfigured for
system level (root) usage.
Copy the default configuration file to */etc/petrified.conf* for global
use, *~/.petrifiedrc* for user-level use, or another location as desired.
At a minimum the **DDNS_KEY** variable must be configured for basic 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
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).
To use a custom configuration file, the **-c (config)** parameter is supported;
note that using this option will *not* read the global/local configuration files
and only use the variables from this custom file.
To use a custom configuration file, the **-c (config)** parameter is
supported; note that using this option will *not* read the global/local
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