-
Notifications
You must be signed in to change notification settings - Fork 1.4k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* feat: init the i18n * fix: porkbun * refactor: http_util GetHTTPResponse * fix: save * fix: add more i18n * feat: i18n at writing.html * feat: README EN * fix: default api * fix: pic
- Loading branch information
Showing
31 changed files
with
703 additions
and
448 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,140 @@ | ||
| # ddns-go | ||
|
|
||
| [ ](https://github.com/jeessy2/ddns-go/releases/latest) [](https://github.com/jeessy2/ddns-go/blob/master/go.mod) [](https://goreportcard.com/report/github.com/jeessy2/ddns-go/v5) [](https://registry.hub.docker.com/r/jeessy/ddns-go) [](https://registry.hub.docker.com/r/jeessy/ddns-go) | ||
|
|
||
| [中文](https://github.com/jeessy2/ddns-go/blob/master/README.md) | English | ||
|
|
||
| Automatically obtain your public IPv4 or IPv6 address and resolve it to the corresponding domain name service. | ||
|
|
||
| - [Features](#Features) | ||
| - [Use in system](#Use-in-system) | ||
| - [Use in docker](#Use-in-docker) | ||
| - [Webhook](#webhook) | ||
| - [Callback](#callback) | ||
| - [Web interfaces](#Web-interfaces) | ||
|
|
||
| ## Features | ||
|
|
||
| - Support Mac, Windows, Linux system, support ARM, x86 architecture | ||
| - Support domain service providers `Aliyun` `Tencent` `Dnspod` `Cloudflare` `Huawei` `Callback` `Baidu` `Porkbun` `GoDaddy` `Google Domain` `Namecheap` `NameSilo` | ||
| - Support interface / netcard / command to get IP | ||
| - Support running as a service | ||
| - Default interval is 5 minutes | ||
| - Support configuring multiple DNS service providers at the same time | ||
| - Support multiple domain name resolution at the same time | ||
| - Support multi-level domain name | ||
| - Configured on the web page, simple and convenient | ||
| - In the web page, you can quickly view the latest 50 logs | ||
| - Support Webhook notification | ||
| - Support TTL | ||
|
|
||
| > [!NOTE] | ||
| > If you enable public network access, it is recommended to use Nginx and other reverse proxy software to enable HTTPS access to ensure security. | ||
| ## Use in system | ||
|
|
||
| - Download and unzip ddns-go from [Releases](https://github.com/jeessy2/ddns-go/releases) | ||
| - Run in service mode | ||
| - Mac/Linux: `sudo ./ddns-go -s install` | ||
| - Win(Run as administrator): `.\ddns-go.exe -s install` | ||
| - [Optional] Uninstall service | ||
| - Mac/Linux: `sudo ./ddns-go -s uninstall` | ||
| - Win(Run as administrator): `.\ddns-go.exe -s uninstall` | ||
| - [Optional] Support installation with parameters `-l` listen address `-f` Sync frequency(seconds) `-cacheTimes` interval N times compared with service providers `-c` custom configuration file path `-noweb` does not start web service `-skipVerify` skip certificate verification `-dns` custom DNS server. example：`./ddns-go -s install -l :9876 -f 600 -c /Users/name/ddns-go.yaml` | ||
| - [Optional] You can use [Homebrew](https://brew.sh) to install [ddns-go](https://formulae.brew.sh/formula/ddns-go) | ||
|
|
||
| ```bash | ||
| brew install ddns-go | ||
| ``` | ||
|
|
||
| ## Use in docker | ||
|
|
||
| - Mount the host directory, use the docker host mode. You can replace `/opt/ddns-go` with any directory on your host, the configuration file is a hidden file | ||
|
|
||
| ```bash | ||
| docker run -d --name ddns-go --restart=always --net=host -v /opt/ddns-go:/root jeessy/ddns-go | ||
| ``` | ||
|
|
||
| - Open `http://DOCKER_IP:9876` in the browser, modify your configuration | ||
|
|
||
| - [Optional] Use `ghcr.io` mirror | ||
|
|
||
| ```bash | ||
| docker run -d --name ddns-go --restart=always --net=host -v /opt/ddns-go:/root ghcr.io/jeessy2/ddns-go | ||
| ``` | ||
|
|
||
| - [Optional] Support startup with parameters `-l`listen address `-f`Sync frequency(seconds) | ||
|
|
||
| ```bash | ||
| docker run -d --name ddns-go --restart=always --net=host -v /opt/ddns-go:/root jeessy/ddns-go -l :9877 -f 600 | ||
| ``` | ||
|
|
||
| - [Optional] Without using docker host mode | ||
|
|
||
| ```bash | ||
| docker run -d --name ddns-go --restart=always -p 9876:9876 -v /opt/ddns-go:/root jeessy/ddns-go | ||
| ``` | ||
|
|
||
| ## Webhook | ||
|
|
||
| - Support webhook, when the domain name is updated successfully or not, the URL filled in will be called back | ||
| - Support variables | ||
|
|
||
| | Variable name | Comments | | ||
| | ---- | ---- | | ||
| | #{ipv4Addr} | The new IPv4 | | ||
| | #{ipv4Result} | IPv4 update result: `no changed` `success` `failed`| | ||
| | #{ipv4Domains} | IPv4 domains，Split by `,` | | ||
| | #{ipv6Addr} | The new IPv6 | | ||
| | #{ipv6Result} | IPv6 update result: `no changed` `success` `failed`| | ||
| | #{ipv6Domains} | IPv6 domains，Split by `,` | | ||
|
|
||
| - If RequestBody is empty, it is a `GET` request, otherwise it is a `POST` request | ||
|
|
||
| - <details><summary>Telegram</summary> | ||
|
|
||
| [ddns-telegram-bot](https://github.com/WingLim/ddns-telegram-bot) | ||
| </details> | ||
| - <details><summary>Discord</summary> | ||
|
|
||
| - Discord client -> Server -> Channel Settings -> Integration -> View Webhook -> New Webhook -> Copy Webhook URL | ||
| - Input the `Webhook URL` copied from Discord in the URL | ||
| - Input in RequestBody | ||
| ```json | ||
| { | ||
| "content": "The domain name #{ipv4Domains} dynamically resolves to #{ipv4Result}.", | ||
| "embeds": [ | ||
| { | ||
| "description": "Domains: #{ipv4Domains}, Result: #{ipv4Result}, IP: #{ipv4Addr}", | ||
| "color": 15258703, | ||
| "author": { | ||
| "name": "DDNS" | ||
| }, | ||
| "footer": { | ||
| "text": "DDNS #{ipv4Result}" | ||
| } | ||
| } | ||
| ] | ||
| } | ||
| ``` | ||
| </details> | ||
|
|
||
| - [More webhook configuration reference](https://github.com/jeessy2/ddns-go/issues/327) | ||
|
|
||
| ## Callback | ||
|
|
||
| - Support more third-party DNS service providers through custom callback | ||
| - Callback will be called as many times as there are lines in the configured domain name | ||
| - Support variables | ||
|
|
||
| | Variable name | Comments | | ||
| | ---- | ---- | | ||
| | #{ip} | The new IPv4/IPv6 address| | ||
| | #{domain} | Current domain | | ||
| | #{recordType} | Record type `A` or `AAAA` | | ||
| | #{ttl} | TTL | | ||
| - If RequestBody is empty, it is a `GET` request, otherwise it is a `POST` request | ||
|
|
||
| ## Web interfaces | ||
|
|
||
|  |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.