docker-cloudflare-ddns/README.md

# Docker Cloudfare DDNS

Simple Docker image that wraps an example script to dynamically update a Cloudflare DNS record.

## Usage

There are two things to configure. First, the domain that you wish to update needs to be provided as a command line argument. This can be done by adding it to the end of your run command (example in the Makefile) or by adding it as a command to your compose file. Eg:

    ddns:
      image: IamTheFij/cloudflare-ddns
      command: ["example.com"]

Your Cloudflare credentials can be passed in any way that [python-cloudflare](https://github.com/cloudflare/python-cloudflare) allows. Generally, either via envioronment variables:

    CF_API_EMAIL=admin@example.com  # Do not set if using an API Token
    CF_API_KEY=00000000000000000000
    CF_API_CERTKEY='v1.0-...'

Or by providing a file mounted to the working directory in the image, `/src/.cloudflare.cfg` that contains something like:

    [CloudFlare]
    emal = admin@example.com  # Do not set if using an API Token
    token = 00000000000000000000
    certtoken = v1.0-...

Then run. To execute from this directory, you can use the convenient Make target.

    make run
Working commit 2019-03-05 19:16:45 +00:00			`# Docker Cloudfare DDNS`
Initial commit 2019-03-05 19:15:08 +00:00
Contain entire build in Dockerfile Rather than pulling and storing the py file, having start script and fetching of qemu files here, everything can just be done in the Dockerfile. 2020-01-22 01:44:02 +00:00			`Simple Docker image that wraps an example script to dynamically update a Cloudflare DNS record.`
Working commit 2019-03-05 19:16:45 +00:00
			`## Usage`

Contain entire build in Dockerfile Rather than pulling and storing the py file, having start script and fetching of qemu files here, everything can just be done in the Dockerfile. 2020-01-22 01:44:02 +00:00			`There are two things to configure. First, the domain that you wish to update needs to be provided as a command line argument. This can be done by adding it to the end of your run command (example in the Makefile) or by adding it as a command to your compose file. Eg:`
Working commit 2019-03-05 19:16:45 +00:00
Contain entire build in Dockerfile Rather than pulling and storing the py file, having start script and fetching of qemu files here, everything can just be done in the Dockerfile. 2020-01-22 01:44:02 +00:00			`ddns:`
			`image: IamTheFij/cloudflare-ddns`
			`command: ["example.com"]`
Working commit 2019-03-05 19:16:45 +00:00
Contain entire build in Dockerfile Rather than pulling and storing the py file, having start script and fetching of qemu files here, everything can just be done in the Dockerfile. 2020-01-22 01:44:02 +00:00			`Your Cloudflare credentials can be passed in any way that [python-cloudflare](https://github.com/cloudflare/python-cloudflare) allows. Generally, either via envioronment variables:`
Working commit 2019-03-05 19:16:45 +00:00
Contain entire build in Dockerfile Rather than pulling and storing the py file, having start script and fetching of qemu files here, everything can just be done in the Dockerfile. 2020-01-22 01:44:02 +00:00			`CF_API_EMAIL=admin@example.com # Do not set if using an API Token`
			`CF_API_KEY=00000000000000000000`
			`CF_API_CERTKEY='v1.0-...'`
Working commit 2019-03-05 19:16:45 +00:00
Contain entire build in Dockerfile Rather than pulling and storing the py file, having start script and fetching of qemu files here, everything can just be done in the Dockerfile. 2020-01-22 01:44:02 +00:00			Or by providing a file mounted to the working directory in the image, `/src/.cloudflare.cfg` that contains something like:
Working commit 2019-03-05 19:16:45 +00:00
Contain entire build in Dockerfile Rather than pulling and storing the py file, having start script and fetching of qemu files here, everything can just be done in the Dockerfile. 2020-01-22 01:44:02 +00:00			`[CloudFlare]`
			`emal = admin@example.com # Do not set if using an API Token`
			`token = 00000000000000000000`
			`certtoken = v1.0-...`
Working commit 2019-03-05 19:16:45 +00:00
Contain entire build in Dockerfile Rather than pulling and storing the py file, having start script and fetching of qemu files here, everything can just be done in the Dockerfile. 2020-01-22 01:44:02 +00:00			`Then run. To execute from this directory, you can use the convenient Make target.`

			`make run`