tengel/petrified
1
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
bash client to update dynamic DNS at freedns.afraid.org
28 commits 2 branches 10 tags 220 KiB
Find a file
troyengel df79cf5f1e adding a few tidbits
2014-11-22 12:43:08 -06:00
arch adding a few tidbits 2014-11-22 12:43:08 -06:00
extra Rename petrified.logrotate to extra/petrified.logrotate 2014-11-22 11:04:44 -06:00
systemd adding systemd timer, instance, target 2014-11-22 08:39:52 -06:00
.gitignore ignoring build files 2014-09-07 18:43:31 -05:00
LICENSE adding 2014-09-07 17:21:40 -05:00
petrified add security check on configs 2014-11-22 10:07:33 -06:00
petrified.conf add message about best security 2014-11-22 09:38:17 -06:00
README.md add security check on configs 2014-11-22 10:07:33 -06:00

README.md

petrified

Copyright (c) 2014 Troy Engel
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.

Features

Several configuration methods:

  • /etc/petrified.conf
  • ~/.petrifiedrc
  • -c (config) on the commandline

High level items of interest:

  • 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, systemd, etc.

Dependencies

Utilities Package
logger, kill util-linux
printf, touch, date, stat, cat, rm coreutils
bash bash
ip iproute2
curl curl

Configuration

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 fully documented and should make sense.

Usage

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.

Acknowledgements

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.

Support

If like this software, please consider upgrading to a Premium account to help support the Free DNS project.