update readme

This commit is contained in:
DataHearth 2021-03-19 23:18:05 +01:00
parent 87c42d98aa
commit 5c3b8abbdd
No known key found for this signature in database
GPG Key ID: E88FD356ACC5F3C4
1 changed files with 19 additions and 5 deletions

View File

@ -7,11 +7,25 @@ Simply run the command `go get github.com/datahearth/ddnsclient`
## Run the client
You have 2 options to run the DDNS client.
You can either run it as a docker container:
`PENDING...`
Or as binary executable:
`PENDING...`
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
- OVH (list of available [regions](https://github.com/ovh/php-ovh/#supported-apis). TO BE CHECKED HOW TO SHIT WORKS)
- OVH
- Google (only one subdomain accepted for now)
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.