/ 
App-DDFlare-0.08-3
River stage zero No dependents
/ ddflare

NAME

ddflare - Command line Dynamic DNS client for CloudFlare

SYNOPSIS

$ ddflare path_to_config

The following flags are accepted

--version            Verssion info
-?|--help            Usage info

-v|--verbose         Verbose output
-o|--output=file     Append output to file
-e|--error=file      Append error to file

CONFIG

The configuration file is YAML in the following structure

--- # Credentials
user: cloudflare-user
key: cloudflare-api-key
--- # Updates dom.com and sub1.dom1.com
zone: dom.com
domains:
 -
 - sub1
--- # Updates sub1.dom2.com and sub2.dom2.com
zone: dom2.com
domains:
 - sub1
 - sub2

FUNCTIONS

loadConfig

Loads in the configuration file, which is YAML, the structure is an array of hashrefs.

The first element being { user => ..., key => ... } which are CloudFlare credentials.

Subsequent elements are { zone => ..., domains => [ ... ] } which are cloudflare zones, and the subdomains within them to update. An undefined value in domains represents the zone itself.

loadConfig($PATH_TO_CONFIG);

AUTHOR

Peter Roberts, <me+ddflare at peter-r.co.uk>

COPYRIGHT/LICENSE

Copyright (c) 2014 Peter Roberts

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.