ddnsclient/README.md

# DDNS Client

## How to install DDNS-CLIENT

Simply run the command `go get github.com/datahearth/ddnsclient`

## Run the client

You have 2 options to run the DDNS client.  
You can run it as: 
- docker container:
`docker run -v /path/to/config/ddnsclient.yaml:/ddnsclient.yaml --name ddnsclient datahearth/ddnsclient:latest`  

- binary executable:
`./ddnsclient` (make sure the config is in the same directory with the name `ddnsclient.yaml`)

## Supported providers

If your provider is not in the list, feel free to open an issue with the tag `provider. I'll do it as soon as possible! Or, even better, you can implement it yourself with a combinaison of issue/PR.

- OVH
- Google (only one subdomain accepted for now)

| Provider        | Note         | Deployed     |
| :-------------: | :----------: | -----------: |
|  OVH            | More Stuff   | YES          |
| Google          | Single subdomain supported | YES |
| DuckDNS   |  | PLANNED |
| No-IP   |  | PLANNED |
| Cloudflare   |  | PLANNED |

Note: For now, ddnsclient supports only one credential for each provider.

## Use the library

You can also plug the library to your own system. Just get the module and you'll find everything needed to start it.
If something is missing or is not working properly, please create an issue so I can fix it.

## 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. 

## 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/