mirror of
https://github.com/taigrr/godns
synced 2025-01-18 04:03:25 -08:00
100 lines
2.3 KiB
Markdown
100 lines
2.3 KiB
Markdown
# GoDNS
|
|
|
|
[](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 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
|
|
```
|
|
|
|
## Get help
|
|
|
|
```bash
|
|
$ ./godns -h
|
|
Usage of ./godns:
|
|
-c string
|
|
Specify a config file (default "./config.json")
|
|
-d Run it as docker mode
|
|
-h Show help
|
|
```
|
|
|
|
## Config 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.
|
|
* 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.
|
|
|
|
## Run it as a daemon manually
|
|
|
|
```bash
|
|
nohup ./godns &
|
|
```
|
|
|
|
## Run it as a daemon, manage it via Upstart
|
|
|
|
* Install `upstart` first
|
|
* Copy `./upstart/godns.conf` to `/etc/init`
|
|
* Start it as a system service:
|
|
|
|
```bash
|
|
sudo start godns
|
|
```
|
|
|
|
## Run it as a daemon, manage it via Systemd
|
|
|
|
* Modify `./systemd/godns.service` and config it.
|
|
* Copy `./systemd/godns.service` to `/lib/systemd/system`
|
|
* Start it as a systemd service:
|
|
|
|
```bash
|
|
sudo systemctl enable godns
|
|
sudo systemctl start godns
|
|
```
|
|
|
|
## Run it in docker
|
|
|
|
Now godns supports to run in docker.
|
|
|
|
* Pull godns image from docker hub:
|
|
```bash
|
|
docker pull timothyye/godns:1.0
|
|
```
|
|
|
|
* Run godns in container and pass config parameters to it via enviroment variables:
|
|
|
|
```bash
|
|
docker run -d --name godns --restart=always \
|
|
-e EMAIL=your_dnspod_account \
|
|
-e PASSWORD=your_dnspod_password \
|
|
-e DOMAINS="your_domain1,your_domain2" DOCKER_IMAGE_ID
|
|
```
|
|
|
|
|
|
|
|
## Enjoy it!
|