mirror of
https://github.com/taigrr/godns
synced 2025-01-18 04:03:25 -08:00
update README file
This commit is contained in:
parent
f428da55c8
commit
0b7bb3d6b9
21
README.md
21
README.md
@ -85,7 +85,7 @@ Usage of ./godns:
|
|||||||
* Get [config_sample.json](https://github.com/timothyye/godns/blob/master/config_sample.json) from Github.
|
* Get [config_sample.json](https://github.com/timothyye/godns/blob/master/config_sample.json) from Github.
|
||||||
* Rename it to **config.json**.
|
* Rename it to **config.json**.
|
||||||
* Configure your provider, domain/sub-domain info, username and password, etc.
|
* Configure your provider, domain/sub-domain info, username and password, etc.
|
||||||
* Configure log file path, max size of log file, max count of log file.
|
* Configure the SMTP options if you want, a mail notification will sent to your mailbox once the IP is changed.
|
||||||
* Save it in the same directory of GoDNS, or use -c=your_conf_path command.
|
* Save it in the same directory of GoDNS, or use -c=your_conf_path command.
|
||||||
|
|
||||||
### Config example for DNSPod
|
### Config example for DNSPod
|
||||||
@ -149,6 +149,25 @@ Remember the DDNS key and fill it as password to the config.json.
|
|||||||
|
|
||||||
__NOTICE__: If you have multiple domains or subdomains, make sure their DDNS key are the same.
|
__NOTICE__: If you have multiple domains or subdomains, make sure their DDNS key are the same.
|
||||||
|
|
||||||
|
### Email notification support
|
||||||
|
|
||||||
|
Update config file and provide your SMTP options, a notification mail will be sent to your mailbox once the IP is changed and updated.
|
||||||
|
|
||||||
|
```json
|
||||||
|
"notify": {
|
||||||
|
"enabled": true,
|
||||||
|
"smtp_server": "smtp.example.com",
|
||||||
|
"smtp_username": "user",
|
||||||
|
"smtp_password": "password",
|
||||||
|
"smtp_port": 25,
|
||||||
|
"send_to": "my_mail@example.com"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
Notification mail example:
|
||||||
|
|
||||||
|
<img src="https://github.com/TimothyYe/godns/blob/master/snapshots/mail.png?raw=true" width="640" />
|
||||||
|
|
||||||
### SOCKS5 proxy support
|
### SOCKS5 proxy support
|
||||||
|
|
||||||
You can also use SOCKS5 proxy, just fill SOCKS5 address to the ```socks5_proxy``` item:
|
You can also use SOCKS5 proxy, just fill SOCKS5 address to the ```socks5_proxy``` item:
|
||||||
|
BIN
snapshots/mail.png
Normal file
BIN
snapshots/mail.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 42 KiB |
Loading…
x
Reference in New Issue
Block a user