Merge pull request #6 from johnjaylward/patch-1
Update Readme with build instructions
This commit is contained in:
commit
e1d1df8415
13
README.md
13
README.md
@ -3,14 +3,19 @@ A simple script in Go language to automatically update Digital ocean DNS records
|
||||
|
||||
To find your Dynamic IP, this program will call out to https://ipv4bot.whatismyipaddress.com for ipv4 addresses and https://ipv6bot.whatismyipaddress.com for ipv6 addresses. This is to support dual-stack environments.
|
||||
|
||||
## requirements
|
||||
Requires Git and Go for building.
|
||||
## Requirements
|
||||
Requires Git, Go 1.8+, and https://github.com/mitchellh/go-homedir for building.
|
||||
|
||||
Requires that the record already exists in DigitalOcean's DNS so that it can be updated.
|
||||
(manually find your IP and add it to DO's DNS it will later be updated)
|
||||
|
||||
Requires a Digital Ocean API key that can be created at https://cloud.digitalocean.com/account/api/tokens.
|
||||
|
||||
## Building
|
||||
You first need to install the "homedir" module if you aren't using it in another project. To install the module, run `go get github.com/mitchellh/go-homedir`
|
||||
|
||||
Once the module is fetched, you should be able to compile the program using `go build`
|
||||
|
||||
## Usage
|
||||
```bash
|
||||
git clone https://github.com/anaganisk/digitalocean-dynamic-dns-ip.git
|
||||
@ -62,9 +67,9 @@ go build digitalocean-dynamic-ip.go
|
||||
```
|
||||
|
||||
Optionally, you can create the configuration file with any name wherever you want, and pass it as a command line argument:
|
||||
````bash
|
||||
```bash
|
||||
#run
|
||||
./digitalocean-dynamic-ip /path/tp/my/config.json
|
||||
./digitalocean-dynamic-ip /path/to/my/config.json
|
||||
```
|
||||
|
||||
You can either set this to run periodically with a cronjob or use your own method.
|
||||
|
Loading…
Reference in New Issue
Block a user