Documentation for Cloudflare (#5723)

* Initial documentation for Cloudflare

* Corrected typo

* ✏️ Tweaks

* ✏️ Tweaks

* Changed records to be required

* correction about records

* Minor changes

* changed ha_release
This commit is contained in:
Joakim Sørensen 2018-07-09 23:39:38 +02:00 committed by Fabian Affolter
parent 5403cf32c2
commit 8ac7b4c329
2 changed files with 58 additions and 0 deletions

View File

@ -0,0 +1,58 @@
---
layout: page
title: "Cloudflare"
description: "Automatically update your Cloudflare DNS records."
date: 2018-07-10 20:08
sidebar: true
comments: false
sharing: true
footer: true
logo: cloudflare.png
ha_category: Utility
featured: false
ha_release: 0.74
---
With the `cloudflare` component can you keep your Cloudflare records up to date.
The component will run every hour, but can also be started manually by using the service `cloudflare.update_records` under services.
## {% linkable_title Setup %}
You will find your global API key in your Cloudflare account settings.
## {% linkable_title Configuration %}
To use the component in your installation, add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
cloudflare:
email: user@example.com
api_key: c2547eb745079dac9320b638f5e225cf483cc5cfdda41
zone: example.com
records:
- bin
- www
```
{% configuration cloudflare %}
email:
description: The email address for your Cloudflare account.
required: true
type: string
api_key:
description: The global API key for your Cloudflare account.
required: true
type: string
zone:
description: The DNS zone you want to update.
required: true
type: string
records:
description: A list of records you want to update.
required: true
type: list
{% endconfiguration %}
This platform uses the API from [ipify.org](https://www.ipify.org/) to set the public IP address.

Binary file not shown.

After

Width:  |  Height:  |  Size: 9.1 KiB