1
0
mirror of https://github.com/taigrr/godns synced 2025-01-18 04:03:25 -08:00
godns/README.md
2016-05-21 17:49:07 +08:00

46 lines
1.2 KiB
Markdown

## GoDNS
[![Build Status](https://travis-ci.org/TimothyYe/godns.svg?branch=master)](https://travis-ci.org/TimothyYe/godns)
GoDNS is a dynamic DNS (DDNS) tool, it is based on my early open source project: [DynDNS](https://github.com/TimothyYe/DynDNS).
Now I rewrite [DynDNS](https://github.com/TimothyYe/DynDNS) by Golang and call it [GoDNS](https://github.com/TimothyYe/godns).
## Pre-condition
* GoDNS relies on [DNSPod](http://dnspod.cn) and its API.
* To use GoDNS, you need a domain and hosted on [DNSPod](http://dnspod.cn).
## Build it
### Get & build it from source code
* Get source code from Github:
```bash
git clone https://github.com/timothyye/godns.git
```
* Go into the godns directory, get related library and then build it:
```bash
cd godns
go get
go build
```
## Run it
* Get [config_sample.json](https://github.com/abotoo/godns/blob/master/config_sample.json) from Github.
* Rename it to **config.json**.
* Configure your domain/sub-domain info, username and password of DNSPod account.
* Configure log file path, max size of log file, max count of log file.
* Configure user id, group id for safety.
* Save it in the same directory of GoDNS, or use -c=your_conf_path command.
* The last step, run godns:
```bash
./godns
```
* Enjoy it!