From eb68d31970e04ed9a6daa6687ec18073a9472b17 Mon Sep 17 00:00:00 2001 From: Tudor Stanciu Date: Tue, 27 Dec 2022 21:31:04 +0200 Subject: [PATCH] readme update --- README.md | 24 +++++++++++++++++++++++- 1 file changed, 23 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 95fc64a..174cca9 100644 --- a/README.md +++ b/README.md @@ -1 +1,23 @@ -# GoDaddyDDNS \ No newline at end of file +# GoDaddyDDNS + +GoDaddy does not have a Dynamic DNS service, but provides documentation to programmatically interact with their platform: https://developer.godaddy.com/doc/endpoint/domains + +Considering this aspect, I wrote this worker to constantly check the public IP of the network in which it is installed and compare it with the one configured in type A records in the GoDaddy platform. When a difference appears between these IPs, the worker will update the correct IP in the configured type A records through the API. + +The worker is developed multi-platform (it can run in any environment), but the tested version is in a docker container. + +To make this worker functional, a minimum configuration is required: + +``` +{ + "Domain": "*********", + "Records": [ "@" ], + "Key": "*********", + "Secret": "*********", + "ExecutionTimeInSeconds": 3300 +} +``` + +## Stack +* .NET (C#) +* Docker