Dynamic DNS for Mac OS X with CloudFlare and ddclient

ddclient-cloudflare-macosx.md

Update June 2019

The patch described below may no longer be necessary. CloudFlare instructions here. Perl module JSON::Any may still be required, however, see comments.

Description

Dyn's free dynamic DNS service will be ending on Wednesday, May 7th, 2014.

CloudFlare, however, has a little known feature that will allow you to update your DNS records via API or a command line script called ddclient. This will give you the same result, and it's also free.

Unfortunately, ddclient does not work with CloudFlare out of the box. There is a patch available and here is how to hack[1] it up on Mac OS X.

Requirements

Homebrew, basic command line skills, and a domain name that you own.

CloudFlare

Sign up to CloudFlare and add your domain name. Follow the instructions, the default values it gives should be fine.

You'll be letting CloudFlare host your domain so you need to adjust the settings at your registrar.

If you'd like to use a subdomain, add an 'A' record for it. Any IP address will do for now.

Let's get to business...

Installation

$ brew install ddclient

Patch

$ sudo cpan install JSON::Any
$ curl -O http://blog.peter-r.co.uk/uploads/ddclient-3.8.0-cloudflare-26-09-2013.patch
$ patch /usr/local/opt/ddclient/sbin/ddclient < ddclient-3.8.0-cloudflare-26-09-2013.patch

Config

$ cp /usr/local/opt/ddclient/share/doc/ddclient/sample-etc_ddclient.conf /usr/local/etc/ddclient/ddclient.conf
$ vim /usr/local/etc/ddclient/ddclient.conf

Add:

##
### CloudFlare (cloudflare.com)
###
ssl=yes
use=web, web=dyndns
protocol=cloudflare, \
server=www.cloudflare.com, \
zone=domain.com, \
[email protected], \
password=api-key \
host.domain.com

Comment out:

#daemon=300

Your api-key comes from the account page
ssl=yes might already be in that file
use=web, web=dyndns will use dyndns to check IP (useful for NAT)

Start at boot

$ sudo cp -fv /usr/local/opt/ddclient/*.plist /Library/LaunchDaemons
$ sudo launchctl load /Library/LaunchDaemons/homebrew.mxcl.ddclient.plist

You're done. Log in to https://www.cloudflare.com and check that the IP listed for your domain matches http://checkip.dyndns.com

---

[1] Don't do this in front of your boss.

I believe you also need to specify a mechanism for determining and updating your external IP (lines 30-66 basically).

This works for me:
edit this line to remove the #

'# use=web, web=checkip.dyndns.org/
use=web, web=checkip.dyndns.org/
'

@tomatohater what configuration magic?

Because I currently have the same error message but have already installed JSON::Any

@cscharff Uncommenting that is already mentioned in the gist.

@tomatohater

What did you do to solve the problem?

I already installed JSON::Any but still getting the error. I am using the latest ddclient version 3.8.3 from Homebrew.

Please Link the latest Patch http://blog.peter-r.co.uk/uploads/ddclient-3.8.0-cloudflare-22-6-2014.patch

Latest version of ddclient from homebrew does NOT need the patch, if you are coming here off the back of dyndns issues then you might also want to try a web config line like this to avoid all dyndns/oracle dependencies:
use=web, web=v4.ident.me/

also latest guidance of homebrew install suggests you don't need to link the LaunchDaemon file either:

==> Downloading https://homebrew.bintray.com/bottles/ddclient-3.9.0.mojave.bottle.tar.gz
######################################################################## 100.0%
==> Pouring ddclient-3.9.0.mojave.bottle.tar.gz
==> Caveats
For ddclient to work, you will need to create a configuration file
in /usr/local/etc/ddclient, a sample configuration can be found in
/usr/local/opt/ddclient/share/doc/ddclient.

Note: don't enable daemon mode in the configuration file; see
additional information below.

The next reboot of the system will automatically start ddclient.

You can adjust the execution interval by changing the value of
StartInterval (in seconds) in /Library/LaunchDaemons/homebrew.mxcl.ddclient.plist,
and then

To have launchd start ddclient now and restart at startup:
  sudo brew services start ddclient