sagi/digitalocean-dyndns
1
0
Fork 0
mirror of https://github.com/tunix/digitalocean-dyndns synced 2024-12-22 04:49:52 +00:00
Code Issues Releases Wiki Activity

Update README.md

Browse source
This commit is contained in:
Alper Kanat 2016-01-23 22:09:58 +02:00
parent a435fb75c5
commit 66661e7922
1 changed files with 30 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

30
README.md
View file

@ -1 +1,31 @@
# Dynamic DNS using DigitalOcean's DNS Services
A script that pushes the public IP address of the running machine to DigitalOcean's DNS API's. It requires an existing A record to update.
## Setup
Assuming you already have a DigitalOcean account and your domain associated with it. Just add an A record with desired name and IP address. That's it!
## Usage
Pick one of the options below using the following settings:
* **DIGITALOCEAN_TOKEN:** The token you generate in DigitalOcean's API settings.
* **DOMAIN:** The domain your subdomain is registered at. (i.e. `foo.com` for `home.foo.com`)
* **NAME:** Subdomain to use. (name in A record) (i.e. `home` for `home.foo.com`)
* **SLEEP_INTERVAL:** Polling time in seconds. (default: 300)
### Docker (Recommended)
```
$ docker pull tunix/digitalocean-dyndns
$ docker run -d --name dyndns -e DIGITALOCEAN_TOKEN="your_token_here" -e DOMAIN="yourdomain.com" -e NAME="subdomain" -e SLEEP_INTERVAL=2 tunix/digitalocean-dyndns
```
### Manual
You can also create a cronjob using below command:
```
$ DIGITALOCEAN_TOKEN="your_token_here" DOMAIN="yourdomain.com" NAME="subdomain" SLEEP_INTERVAL=2 ./dyndns.sh
```