mirror of
https://github.com/taigrr/godns
synced 2025-01-18 04:03:25 -08:00
Update readme file & sample config file
This commit is contained in:
parent
95bcdb15b6
commit
4d325c0d20
52
README.md
52
README.md
@ -1,6 +1,50 @@
|
||||
godns
|
||||
=====
|
||||
## GoDNS
|
||||
|
||||
[](https://drone.io/github.com/TimothyYe/godns/latest)
|
||||
[](https://travis-ci.org/TimothyYe/godns)
|
||||
|
||||
A dynamic DNS tool, based on dnspod, written by Golang.
|
||||
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 is relied to [DNSPod](http://dnspod.cn) and its API.
|
||||
|
||||
To use GoDNS, you need to have a domain and host it 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
|
||||
```
|
||||
* Then you get GoDNS.
|
||||
|
||||
### Build godns from the 3rd party
|
||||
|
||||
* Visit this URL provided by [GoBuild](http://gobuild.io/download/github.com/TimothyYe/godns).
|
||||
* Select the platform you need.
|
||||
* Input the build type and branch name.
|
||||
* Build and download GoDNS.
|
||||
|
||||
## Run it
|
||||
|
||||
* Get [config_sample.json](https://github.com/TimothyYe/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.
|
||||
* Save it in the same directory of GoDNS.
|
||||
* The last step, run godns:
|
||||
```bash
|
||||
nohup ./godns &
|
||||
```
|
||||
* Enjoy it!
|
||||
|
@ -3,5 +3,5 @@
|
||||
"password": "",
|
||||
"domain": "",
|
||||
"sub_domain": "",
|
||||
"ip_url": ""
|
||||
"ip_url": "http://members.3322.org/dyndns/getip"
|
||||
}
|
Loading…
x
Reference in New Issue
Block a user