Skip to content

Commit

Permalink
Name fix
Browse files Browse the repository at this point in the history
- update readme
  • Loading branch information
Sandoun committed Jan 1, 2024
1 parent 7feff3f commit ea31f04
Show file tree
Hide file tree
Showing 2 changed files with 36 additions and 3 deletions.
35 changes: 34 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,34 @@
# DynDNSv2
# DynDNSv2

This is a docker wrapper arround the DynDNS v2 API that automatically updates the DNS server whenever the public IP of the system changes.

# Usage

## Docker Compose

This is an example using the strato.de DynDNS api

```yaml
version: "3"
services:
dyndnsv2:
image: ghcr.io/sandoun/dyndnsv2:latest
container_name: dyndnsv2
environment:
- UPDATE_URL=https://dyndns.strato.com/nic/update
- USERNAME=*YOUR USERNAME*
- PASSWORD=*YOUR PASSWORD*
- UPDATE_DOMAIN_1=domain.com
- UPDATE_DOMAIN_2=subdomain1.domain.com
- UPDATE_DOMAIN_3=subdomain2.domain.com
#add more by incrementing by 1
```

## Environment Variables

|Name|Description|Example|
|----|-----|-------|
|UPDATE_URL|The update URL of your provider|https://dyndns.strato.com/nic/update|
|USERNAME|Your login username|Username|
|PASSWORD|Your login password|Password123|
|UPDATE_DOMAIN_[N]|A domain to update, it starts with N=1 and increments by 1 for each additional one|domain.com
4 changes: 2 additions & 2 deletions src/DynDNSv2/Updater.cs
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ protected override async Task ExecuteAsync(CancellationToken stoppingToken)
int i = 1;
while(true)
{
var found = Environment.GetEnvironmentVariable($"UPDATE_URL_{i}");
var found = Environment.GetEnvironmentVariable($"UPDATE_DOMAIN_{i}");

if(!string.IsNullOrEmpty(found))
{
Expand All @@ -78,7 +78,7 @@ protected override async Task ExecuteAsync(CancellationToken stoppingToken)
}

if(updateLst.Count <= 0)
throw new Exception("No UPDATE_URL_[N] env variable found, pleace specify one with UPDATE_URL_1, UPDATE_URL_2 ...");
throw new Exception("No UPDATE_DOMAIN_[N] env variable found, pleace specify one with UPDATE_DOMAIN_1, UPDATE_DOMAIN_2 ...");

updateDomains = updateLst.ToArray();

Expand Down

0 comments on commit ea31f04

Please sign in to comment.