DataHearth
/
ddnsclient
1
0
Fork 0
Code Issues Pull Requests Actions Releases Activity

Update README.md

This commit is contained in:
Antoine Langlois 2021-05-27 12:44:04 +02:00 committed by GitHub
parent d9945bd290
commit 7ccd33c22a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 10 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@ -30,17 +30,20 @@ make sure the config is in the same directory with the name `ddnsclient.yaml` or
Any provider using the standard for DDNS should be supported by default thanks to the generic configuration.
You just need to get your credentials (obviously) and the update URL.
If you face any kind of issue, feel free to open an issue and ping me in it. If necessarry, a branch will be open to fix the problem.
If you face any kind of issue, feel free to open an issue and ping me in it. If necessary, a branch will be open to fix the problem.
| Provider | Configuration key | Implemented | Tested |
|------------ |------------------- |------------- |-------- |
| OVH | ovh | YES | YES |
| GOOGLE | google | YES | YES |
| DuckDNS | duckdns | YES | YES |
| No-IP | noip | NO | NO |
| DynDNS | dyndns | NO | NO |
| DuckDNS | duckdns | YES | YES |
| No-IP | noip | YES | NO |
| DynDNS | dyndns | YES | NO |
| CloudFlare | cloudflare | NO | NO |
Note:
For DDNS providers using basic authentication inside URL (e.g: `https://{username}:{password}@ddns.something.com/...`), remove the `username`and `password` part to get only the "classical" URL (e.g: `https://ddns.something.com/...`). Then fill the `username` and `password` fields in the provider configuration.
## Contributing
You can contribute to the project by submitting an issue and resolve issues by creating PRs. I'll look at them and validate your changes if they're correct as soon as possible.
@ -53,4 +56,6 @@ You can contribute to the project by submitting an issue and resolve issues by c
## Useful links
- Google DDNS doc: https://support.google.com/domains/answer/6147083?hl=en#zippy=%2Cusing-the-api-to-update-your-dynamic-dns-record
- OVH DDNS doc: https://docs.ovh.com/us/en/domains/hosting_dynhost/
- DuckDNS DDNS doc: https://www.duckdns.org/spec.jsp
- DuckDNS DDNS doc: https://www.duckdns.org/spec.jsp
- No-IP DDNS doc: https://www.noip.com/integrate/request
- DynDNS DDNS doc: https://help.dyn.com/remote-access-api/perform-update/