From 1987571074bf544ca0ee47388fdbc23068aad6fb Mon Sep 17 00:00:00 2001 From: Beat <508289+bdurrer@users.noreply.github.com> Date: Sat, 31 Mar 2018 13:07:31 +0200 Subject: [PATCH] Add FreeDNS component (#5046) * Add FreeDNS component * Move the instructions up --- source/_components/freedns.markdown | 49 +++++++++++++++++++ .../development_guidelines.markdown | 2 +- 2 files changed, 50 insertions(+), 1 deletion(-) create mode 100644 source/_components/freedns.markdown diff --git a/source/_components/freedns.markdown b/source/_components/freedns.markdown new file mode 100644 index 00000000000..960d1411d99 --- /dev/null +++ b/source/_components/freedns.markdown @@ -0,0 +1,49 @@ +--- +layout: page +title: "freedns.afraid.org" +description: "Keep your DNS record up to date with FreeDNS." +date: 2018-03-27 21:30 +sidebar: true +comments: false +sharing: true +footer: true +ha_category: Utility +ha_release: 0.67 +--- + +With the `freedns` component you can keep your [FreeDNS](https://freedns.afraid.org) record up to date. + +## {% linkable_title Configuration %} + +You need to determine your update URL or your access token. + +1. Head over to the [FreeDNS](https://freedns.afraid.org) website and login to your account. +2. Select the menu "Dynamic DNS" +3. You should now see your update candiates in a table at the bottom of the page. +4. Copy the link target of the "Direct URL". +5. The access token is the part at the end of the link: `https://freedns.afraid.org/dynamic/update.php?YOUR_UPDATE_TOKEN` +6. Either put the token as `access_token` _or_ the whole URL into the `url` attribute. + +To use the component in your installation, add the following to your `configuration.yaml` file: + +```yaml +# Example configuration.yaml entry +freedns: + access_token: YOUR_TOKEN +``` + +{% configuration %} + access_token: + description: Your access token. This is exclusive to `url`. + required: false + type: string + url: + description: The full update URL. This is exclusive to `access_token`. + required: false + type: string + update_interval: + description: How often to call the update service. + required: false + type: time period + default: 10 minutes +{% endconfiguration %} diff --git a/source/developers/development_guidelines.markdown b/source/developers/development_guidelines.markdown index edfabb9b26b..7e4088249ce 100644 --- a/source/developers/development_guidelines.markdown +++ b/source/developers/development_guidelines.markdown @@ -78,4 +78,4 @@ _LOGGER.error("No route to device: %s", self._resource) ``` Don't print out wrong API keys, tokens, usernames, or passwords. - +Also note that `_LOGGER.info` is reserved for the core, use `_LOGGER.debug` in anything else.