michi.vonah/adguard-ddns-client
1
0
Fork 0
mirror of https://github.com/michivonah/adguard-ddns-client.git synced 2025-12-22 22:26:28 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

update tutorial in readme

Browse source
This commit is contained in:
michivonah 2024-01-11 21:23:50 +01:00
parent 9a482c3c95
commit 9bbb4cc584
1 changed files with 6 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

9
README.md
View file

@ -13,11 +13,14 @@ Use as docker container on your server:
```crontab -e``` ```crontab -e```
3. Add the following line and change the enviromental variables to your server 3. Add the following line to the cronjob of your server and change the enviromental variables for your needs
```0 * * * * docker run -d --rm --env API_BASE_URL="https://example.com" --env API_USERNAME=YOUR_USER --env API_PASSWORD=YOUR_PASSWORD --env DOMAIN_NAME=YOUR_DDNS_DOMAIN adguard-ddns-client``` ```0 * * * * docker run -d --rm --env API_BASE_URL="https://example.com" --env API_USERNAME=YOUR_USER --env API_PASSWORD=YOUR_PASSWORD --env DOMAIN_NAME=YOUR_DDNS_DOMAIN ghcr.io/michivonah/adguard-ddns-client:main```
4. Finished. Now the cronjobs runs every hour and adds the clients ip address if it is missing. Replace `0 * * * *` to run the job more often than once a hour.
Use `0/30 * * * *` to run the job every 30 mins or `5 * * * *` to run the job every 5 minutes. Customize it to your needs.
4. Finished. Now the cronjobs runs as defined and adds the clients ip address if it is missing to AdGuard Home's Client whitelist.
## Enviormental variables ## Enviormental variables
These environment variables are supported These environment variables are supported