rickmur / CloudFlareDDNS

Simple Dynamic DNS script to update CloudFlare DNS records

CloudFlare DNS Updating tool

Simple Dynamic DNS client for CloudFlare written in Python

This is a simple script to update a CloudFlare DNS record with your WAN IP. CloudFlare by default doesn't support Dynamic DNS updates from other platforms than its default program (ddclient). I wrote this script to run on my Synology NAS, but it can run on any system with Python and PIP.

This has been an exercise to get familier with Python, so any comments and improvements regarding my code are welcome!

In version 2 the support for IPv6 is added!

If you encounter a problem, please file a Github issue.

##How to get started

1. Download the files on your system using git clone https://github.com/rickmur/CloudFlareDDNS.git. Any further updates are downloaded using git pull from the new directory
2. Install required libraries with pip install -r requirements.txt. If your Synology doesn't have pip installed yet, follow the steps in the next section
3. Copy CFupdater.default to CFupdater.conf with cp CFupdater.default CPupdater.conf
4. Edit CFupdater.conf to include your CloudFlare username (e-mail), API key (found in Settings panel) and your domainnames (zones) and records as per the example below
5. Make sure to use spaces instead of tabs in the configuration file, YAML prohibits the use of tabs
6. Run crontab -e or on Synology platforms vi /etc/crontab and append a line to enable recurring updates as per the example below

#####Install PIP on Synology

1. Set-up SSH to your Synology NAS
2. Enter wget https://raw.github.com/pypa/pip/master/contrib/get-pip.py
3. Run python get-pip.py
4. Be aware that PIP and the modules can be deleted after a DSM upgrade

#####Sample crontab job The following line should be appended to your crontab file (edited either with crontab -e or on Synology with vi /etc/crontab. This line will execute the script every hour on every day on minute 0 of each hour.

0       *       *       *       *       root    python /PATH_TO_FILES/CFupdater.py

##Sample configuration

• Please be careful with sharing the CloudFlare API key and E-mail, treat it as a username/password.
• There is no limit on the amount of zones and records per zone
• If you want to update the root A/AAAA-record of your zone (known as @ in Cloudlare) like example.com, use root as the record name
• IPv6 zones are configured in the zones_v6 section
• The isp_prefixlength should be left as /64 or set to the value you received from your ISP
• dynamic entries will use the exact IPv6 address gathered during the run of the script. Other entries are should define host part of the IPv6 address and the script will gather the ISP prefix
• If you want to enable logging, use the file setting to set all logging to output to a file in the same directory.
• If you want to enable syslog which will output to your system default logfile use the syslog setting and set to true or false to enable or disable
• When all logging settings are removed, only text output is shown when running the script

# List of DNS zones to check
# Use the keyword 'root' to match the A-record of the domain itself, like 'example.com'
---
cloudflareEmail: yourEmailToLogin
cloudflareAuthKey: yourAPIkey

# Define A-records (IPv4) that need to be updated
zones:
    example.com:
        - root
        - home
    example2.net:
        - www
        - myhost

# Define AAAA-records (IPv6) that need to be updated
zones_v6:
    isp_prefixlength: /64,
    example.com:
        www: dynamic,
        test: ::1
    sample.cloud:
        root: :BAD::1,
        myrecord: :BAD::10

# Put a file name with full path (or without in case you want to use the CFupdater.py directory)
# Syslog logs to your systems default log file, use True or False to enable/disable
logging:
    file: CFupdater.log
    syslog: true

##License This software is licensed under the Apache License, Version 2.0 (the "License"); you may not use this software except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Copyright (c) 2016 - Maverick.Solutions - Rick Mur