diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 17 |
1 files changed, 17 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..e8c7160 --- /dev/null +++ b/README.md @@ -0,0 +1,17 @@ +# Cloudflare AutoDNS + +A bash script to update your dns (for cloudflare) for those who run servers with a dynamic IP + +## How to + +The following enviornment variables are to be set +``` +1. API_TOKEN Your cloudflare API token +2. ZONE The zone contaning the dns record +3. DOMAIN The domain record in the zone to be updated +``` +This script is best used with a cron job + +## License + +This project is Licensed under the [GPLv3](https://www.gnu.org/licenses/gpl-3.0.en.html) |