Skip to content

Commit

Permalink
Update documentation, refers to #109
Browse files Browse the repository at this point in the history
  • Loading branch information
qdm12 committed Oct 14, 2020
1 parent f5b34da commit 6c73711
Show file tree
Hide file tree
Showing 4 changed files with 15 additions and 4 deletions.
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/bug.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ assignees: qdm12

2. What DNS service provider(s) are you using?

- [ ] Azure
- [x] Cloudflare
- [ ] DDNSS.de
- [ ] DonDominio
Expand Down
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/help.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ assignees:

2. What DNS service provider(s) are you using?

- [ ] Azure
- [x] Cloudflare
- [ ] DDNSS.de
- [ ] DonDominio
Expand Down
2 changes: 1 addition & 1 deletion Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ LABEL \
org.opencontainers.image.documentation="https://github.com/qdm12/ddns-updater" \
org.opencontainers.image.source="https://github.com/qdm12/ddns-updater" \
org.opencontainers.image.title="ddns-updater" \
org.opencontainers.image.description="Universal DNS updater with WebUI. Works with Cloudflare, DDNSS.de, DNSOMatic, DNSPod, Dreamhost, DuckDNS, DynDNS, GoDaddy, Google, He.net, Infomaniak, Namecheap and NoIP"
org.opencontainers.image.description="Universal DNS updater with WebUI. Works with Azure, Cloudflare, DDNSS.de, DNSOMatic, DNSPod, Dreamhost, DuckDNS, DynDNS, GoDaddy, Google, He.net, Infomaniak, Namecheap and NoIP"
COPY --from=alpine --chown=1000 /etc/ssl/certs/ca-certificates.crt /etc/ssl/certs/
COPY --from=alpine --chown=1000 /usr/share/zoneinfo /usr/share/zoneinfo
EXPOSE 8000
Expand Down
15 changes: 12 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Lightweight universal DDNS Updater with Docker and web UI

*Light container updating DNS A records periodically for Cloudflare, DDNSS.de, DonDominio, DNSOMatic, DNSPod, Dreamhost, DuckDNS, DynDNS, GoDaddy, Google, He.net, Infomaniak, Namecheap and NoIP*
*Light container updating DNS A records periodically for Azure, Cloudflare, DDNSS.de, DonDominio, DNSOMatic, DNSPod, Dreamhost, DuckDNS, DynDNS, GoDaddy, Google, He.net, Infomaniak, Namecheap and NoIP*

[![DDNS Updater by Quentin McGaw](https://github.com/qdm12/ddns-updater/raw/master/readme/title.png)](https://hub.docker.com/r/qmcgaw/ddns-updater)

Expand All @@ -17,7 +17,7 @@

## Features

- Updates periodically A records for different DNS providers: Cloudflare, DDNSS.de, DonDominio, DNSOMatic, DNSPod, Dreamhost, DuckDNS, DynDNS, GoDaddy, Google, He.net, Infomaniak, Namecheap and NoIP ([create an issue](https://github.com/qdm12/ddns-updater/issues/new/choose) for more)
- Updates periodically A records for different DNS providers: Azure, Cloudflare, DDNSS.de, DonDominio, DNSOMatic, DNSPod, Dreamhost, DuckDNS, DynDNS, GoDaddy, Google, He.net, Infomaniak, Namecheap and NoIP ([create an issue](https://github.com/qdm12/ddns-updater/issues/new/choose) for more)
- Web User interface

![Web UI](https://raw.githubusercontent.com/qdm12/ddns-updater/master/readme/webui.png)
Expand Down Expand Up @@ -114,14 +114,23 @@ Start by having the following content in *config.json*, or in your `CONFIG` envi

The following parameters are to be added:

For all record update configuration, you have to specify the DNS provider with `"provider"` which can be `"cloudflare"`, `"ddnss"`, `"dondominio"`, `"dnsomatic"`, `"dnspod"`, `"dreamhost"`, `"duckdns"`, `"dyn"`, `"godaddy"`, `"google"`, `"he"`, `"infomaniak"`, `"namecheap"` or `"noip"`.
For all record update configuration, you have to specify the DNS provider with `"provider"` which can be `"azure"`, `"cloudflare"`, `"ddnss"`, `"dondominio"`, `"dnsomatic"`, `"dnspod"`, `"dreamhost"`, `"duckdns"`, `"dyn"`, `"godaddy"`, `"google"`, `"he"`, `"infomaniak"`, `"namecheap"` or `"noip"`.
You can optionnally add the parameters:

- `"no_dns_lookup"` can be `true` or `false` and allows, if `true`, to prevent the program from doing assumptions from DNS lookups returning an IP address not matching your public IP address (in example for proxied records on Cloudflare).
- `"provider_ip"` can be `true` or `false`. It is only available for the providers `ddnss`, `duckdns`, `he`, `infomaniak`, `namecheap`, `noip` and `dyndns`. It allows to let your DNS provider to determine your IPv4 address (and/or IPv6 address) automatically when you send an update request, without sending the new IP address detected by the program in the request.

For each DNS provider exist some specific parameters you need to add, as described below:

Azure:

- `"domain"`
- `"host"` is your host and can be a subdomain or `"@"`
- `"subscription_id"`
- `"resource_group_name"`
- `"zone_name"`
- `"relative_record_set_name"`

Namecheap:

- `"domain"`
Expand Down

0 comments on commit 6c73711

Please sign in to comment.