1818[ 13 ] : https://godoc.org/github.com/TimothyYe/godns?status.svg
1919[ 14 ] : https://godoc.org/github.com/TimothyYe/godns
2020
21- [ GoDNS] ( https://github.com/TimothyYe/godns ) is a dynamic DNS (DDNS) client tool . It is a rewrite in [ Go] ( https://golang.org ) of my early [ DynDNS] ( https://github.com/TimothyYe/DynDNS ) open-source project.
21+ [ GoDNS] ( https://github.com/TimothyYe/godns ) is a self-hosted dynamic DNS (DDNS) client with multi-provider support and a built-in web panel . It is a rewrite in [ Go] ( https://golang.org ) of my early [ DynDNS] ( https://github.com/TimothyYe/DynDNS ) open-source project.
2222
2323[ 查看中文帮助文档] ( README_CN.md )
2424
@@ -33,71 +33,14 @@ Below is the built-in web panel of the open-source GoDNS project:
3333<img src =" https://github.com/TimothyYe/godns/blob/master/assets/snapshots/web-panel.jpg?raw=true " />
3434
3535- [ Supported DNS Providers] ( #supported-dns-providers )
36+ - [ Quick Start] ( #quick-start )
3637- [ Supported Platforms] ( #supported-platforms )
37- - [ Pre-conditions] ( #pre-conditions )
38+ - [ Self-hosting Pre-conditions] ( #self-hosting- pre-conditions )
3839- [ Installation] ( #installation )
39- - [ Usage] ( #usage )
4040- [ Configuration] ( #configuration )
41- - [ Overview] ( #overview )
42- - [ Multi-Provider Support] ( #multi-provider-support )
43- - [ Configuration file format] ( #configuration-file-format )
44- - [ Dynamic loading of configuration] ( #dynamic-loading-of-configuration )
45- - [ Configuration properties] ( #configuration-properties )
46- - [ Update root domain] ( #update-root-domain )
47- - [ Configuration examples] ( #configuration-examples )
48- - [ Cloudflare] ( #cloudflare )
49- - [ DigitalOcean] ( #digitalocean )
50- - [ DNSPod] ( #dnspod )
51- - [ Dreamhost] ( #dreamhost )
52- - [ Dynv6] ( #dynv6 )
53- - [ Google Domains] ( #google-domains )
54- - [ AliDNS] ( #alidns )
55- - [ DuckDNS] ( #duckdns )
56- - [ No-IP] ( #no-ip )
57- - [ HE.net] ( #henet )
58- - [ Scaleway] ( #scaleway )
59- - [ Linode] ( #linode )
60- - [ Strato] ( #strato )
61- - [ LoopiaSE] ( #loopiase )
62- - [ Infomaniak] ( #infomaniak )
63- - [ Hetzner] ( #hetzner )
64- - [ OVH] ( #ovh )
65- - [ Porkbun] ( #porkbun )
66- - [ Dynu] ( #dynu )
67- - [ IONOS] ( #ionos )
68- - [ TransIP] ( #transip )
69- - [ Notifications] ( #notifications )
70- - [ Email] ( #email )
71- - [ Telegram] ( #telegram )
72- - [ Slack] ( #slack )
73- - [ Discord] ( #discord )
74- - [ Pushover] ( #pushover )
75- - [ Bark] ( #bark )
76- - [ Ntfy] ( #ntfy )
77- - [ Webhook] ( #webhook )
78- - [ Webhook with HTTP GET request] ( #webhook-with-http-get-request )
79- - [ Webhook with HTTP POST request] ( #webhook-with-http-post-request )
80- - [ Miscellaneous topics] ( #miscellaneous-topics )
81- - [ IPv6 support] ( #ipv6-support )
82- - [ Network interface IP address] ( #network-interface-ip-address )
83- - [ SOCKS5 proxy support] ( #socks5-proxy-support )
84- - [ Display debug info] ( #display-debug-info )
85- - [ Obtain IP from RouterOS] ( #obtain-ip-from-router-os )
86- - [ Multiple API URLs] ( #multiple-api-urls )
87- - [ Recommended APIs] ( #recommended-apis )
8841- [ Web Panel] ( #web-panel )
8942- [ Running GoDNS] ( #running-godns )
90- - [ Manually] ( #manually )
91- - [ As a manual daemon] ( #as-a-manual-daemon )
92- - [ As a managed daemon (with upstart)] ( #as-a-managed-daemon-with-upstart )
93- - [ As a managed daemon (with systemd)] ( #as-a-managed-daemon-with-systemd )
94- - [ As a managed daemon (with procd)] ( #as-a-managed-daemon-with-procd )
95- - [ As a Docker container] ( #as-a-docker-container )
96- - [ As a Windows service] ( #as-a-windows-service )
9743- [ Contributing] ( #contributing )
98- - [ Setup the frontend development environment] ( #setup-the-frontend-development-environment )
99- - [ Build the frontend] ( #build-the-frontend )
100- - [ Run the frontend] ( #run-the-frontend )
10144
10245---
10346
@@ -151,6 +94,15 @@ Below is the built-in web panel of the open-source GoDNS project:
15194
15295Tip: You can follow this [ issue] ( https://github.com/TimothyYe/godns/issues/76 ) to view the current status of DDNS for root domains.
15396
97+ ## Quick Start
98+
99+ Choose the path that fits you best:
100+
101+ - Want a managed service with no self-hosting: use [ godns.app] ( https://godns.app ) .
102+ - Want the fastest self-hosted setup: download a binary from [ releases] ( https://github.com/TimothyYe/godns/releases ) .
103+ - Want to run it in a container: jump to [ As a Docker container] ( #as-a-docker-container ) .
104+ - Want to build from source: see [ Installation] ( #installation ) .
105+
154106## Supported Platforms
155107
156108- Linux
@@ -167,9 +119,9 @@ Tip: You can follow this [issue](https://github.com/TimothyYe/godns/issues/76) t
167119
168120 The binary can run on routers as well.
169121
170- ## Pre-conditions
122+ ## Self-hosting Pre-conditions
171123
172- To use GoDNS, it is assumed:
124+ To self-host GoDNS, it is assumed:
173125
174126- You registered (now own) a domain
175127- Domain was delegated to a supported [ DNS provider] ( #supported-dns-providers ) (i.e. it has nameserver ` NS ` records pointing at a supported provider)
@@ -178,16 +130,18 @@ Alternatively, you can sign in to [DuckDNS](https://www.duckdns.org) (with a soc
178130
179131## Installation
180132
181- Build GoDNS by running (from the root of the repository):
133+ Choose one of the following installation methods:
134+
135+ - Download a compiled binary from [ releases] ( https://github.com/TimothyYe/godns/releases ) .
136+ - Use the Docker image described in [ As a Docker container] ( #as-a-docker-container ) .
137+ - Build from source:
182138
183139``` bash
184140cd cmd/godns # go to the GoDNS directory
185141go mod download # get dependencies
186142go build # build
187143```
188144
189- You can also download a compiled binary from the [ releases] ( https://github.com/TimothyYe/godns/releases ) .
190-
191145## Usage
192146
193147Print usage/help by running:
0 commit comments