From 1e9621981c9350d1ad53289bec18d6a8d5bdf4f4 Mon Sep 17 00:00:00 2001 From: Rich O Date: Thu, 15 Jul 2021 16:06:48 +0000 Subject: [PATCH] Update README.md --- README.md | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 101d91a..231c2f8 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,13 @@ *** This project lives at https://gitlab.rickelobe.com/Scripts/cloudflare-dns-updater *** # Description -This script will keep a CloudFlare DNS record up to date with your current public IP address. It will use 'dig' to query the IP address for the DNS record, then compare that IP to your current public IP. If the two IP's do not match, the DNS record will be updated with the current IP address via Cloudfare's API. +Use this script to keep a CloudFlare DNS record up to date with your current public IP address. + +When executed, the script will perform a lookup on the DNS record and compare the result with your current public IP. If the record does not match your current IP, the record will be updated using Cloudflare's API. + +# Prerequisites + +- Cloudflare managed DNS and Account +- Linux host to run the script within your network + +