Skip to content

Commit 769620a

Browse files
committed
update README files
1 parent e17b9b0 commit 769620a

File tree

2 files changed

+38
-130
lines changed

2 files changed

+38
-130
lines changed

README.md

Lines changed: 19 additions & 65 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
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

15295
Tip: 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
184140
cd cmd/godns # go to the GoDNS directory
185141
go mod download # get dependencies
186142
go 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

193147
Print usage/help by running:

README_CN.md

Lines changed: 19 additions & 65 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
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) 是一个动态 DNS (DDNS) 客户端工具。它是用 [Go](https://golang.org) 重写的我早期的 [DynDNS](https://github.com/TimothyYe/DynDNS) 开源项目。
21+
[GoDNS](https://github.com/TimothyYe/godns) 是一个支持多提供商并内置 Web 面板的开源自建动态 DNS (DDNS) 客户端。它是用 [Go](https://golang.org) 重写的我早期的 [DynDNS](https://github.com/TimothyYe/DynDNS) 开源项目。
2222

2323
## 托管版服务
2424

@@ -31,71 +31,14 @@
3131
<img src="https://github.com/TimothyYe/godns/blob/master/assets/snapshots/web-panel.jpg?raw=true" />
3232

3333
- [支持的 DNS 提供商](#支持的-dns-提供商)
34+
- [快速开始](#快速开始)
3435
- [支持的平台](#支持的平台)
35-
- [前提条件](#前提条件)
36+
- [开源自建版前提条件](#开源自建版前提条件)
3637
- [安装](#安装)
37-
- [使用方法](#使用方法)
3838
- [配置](#配置)
39-
- [概述](#概述)
40-
- [多提供商支持](#多提供商支持)
41-
- [配置文件格式](#配置文件格式)
42-
- [动态加载配置](#动态加载配置)
43-
- [配置属性](#配置属性)
44-
- [更新根域名](#更新根域名)
45-
- [配置示例](#配置示例)
46-
- [Cloudflare](#cloudflare)
47-
- [DigitalOcean](#digitalocean)
48-
- [DNSPod](#dnspod)
49-
- [Dreamhost](#dreamhost)
50-
- [Dynv6](#dynv6)
51-
- [Google Domains](#google-domains)
52-
- [AliDNS](#alidns)
53-
- [DuckDNS](#duckdns)
54-
- [No-IP](#no-ip)
55-
- [HE.net](#henet)
56-
- [Scaleway](#scaleway)
57-
- [Linode](#linode)
58-
- [Strato](#strato)
59-
- [LoopiaSE](#loopiase)
60-
- [Infomaniak](#infomaniak)
61-
- [Hetzner](#hetzner)
62-
- [OVH](#ovh)
63-
- [Porkbun](#porkbun)
64-
- [Dynu](#dynu)
65-
- [IONOS](#ionos)
66-
- [TransIP](#transip)
67-
- [通知](#通知)
68-
- [电子邮件](#电子邮件)
69-
- [Telegram](#telegram)
70-
- [Slack](#slack)
71-
- [Discord](#discord)
72-
- [Pushover](#pushover)
73-
- [Bark](#bark)
74-
- [Ntfy](#ntfy)
75-
- [Webhook](#webhook)
76-
- [使用 HTTP GET 请求的 Webhook](#使用-http-get-请求的-webhook)
77-
- [使用 HTTP POST 请求的 Webhook](#使用-http-post-请求的-webhook)
78-
- [杂项主题](#杂项主题)
79-
- [IPv6 支持](#ipv6-支持)
80-
- [网络接口 IP 地址](#网络接口-ip-地址)
81-
- [SOCKS5 代理支持](#socks5-代理支持)
82-
- [显示调试信息](#显示调试信息)
83-
- [从 RouterOS 获取 IP](#从-routeros-获取-ip)
84-
- [多个 API URL](#多个-api-url)
85-
- [推荐的 API](#推荐的-api)
8639
- [Web 面板](#web-面板)
8740
- [运行 GoDNS](#运行-godns)
88-
- [手动运行](#手动运行)
89-
- [作为手动守护进程](#作为手动守护进程)
90-
- [作为托管守护进程(使用 upstart)](#作为托管守护进程使用-upstart)
91-
- [作为托管守护进程(使用 systemd)](#作为托管守护进程使用-systemd)
92-
- [作为托管守护进程(使用 procd)](#作为托管守护进程使用-procd)
93-
- [作为 Docker 容器](#作为-docker-容器)
94-
- [作为 Windows 服务](#作为-windows-服务)
9541
- [贡献](#贡献)
96-
- [设置前端开发环境](#设置前端开发环境)
97-
- [构建前端](#构建前端)
98-
- [运行前端](#运行前端)
9942

10043
---
10144

@@ -149,6 +92,15 @@
14992

15093
提示:您可以关注此 [问题](https://github.com/TimothyYe/godns/issues/76) 查看根域名 DDNS 的当前状态。
15194

95+
## 快速开始
96+
97+
请选择最适合你的方式:
98+
99+
- 如果你想直接使用托管服务而不自建:使用 [godns.app](https://godns.app)
100+
- 如果你想最快速地开始自建:从 [releases](https://github.com/TimothyYe/godns/releases) 下载二进制文件。
101+
- 如果你想用容器运行:直接看 [作为 Docker 容器](#作为-docker-容器)
102+
- 如果你想从源码构建:看 [安装](#安装)
103+
152104
## 支持的平台
153105

154106
- Linux
@@ -165,9 +117,9 @@
165117

166118
该二进制文件也可以在路由器上运行。
167119

168-
## 前提条件
120+
## 开源自建版前提条件
169121

170-
要使用 GoDNS,假设:
122+
要自建部署 GoDNS,假设:
171123

172124
- 您已注册(现在拥有)一个域名
173125
- 域名已委托给受支持的 [DNS 提供商](#支持的-dns-提供商)(即它有指向受支持提供商的 nameserver `NS` 记录)
@@ -176,16 +128,18 @@
176128

177129
## 安装
178130

179-
通过运行以下命令构建 GoDNS(从仓库根目录):
131+
你可以选择以下安装方式之一:
132+
133+
-[releases](https://github.com/TimothyYe/godns/releases) 下载已编译的二进制文件。
134+
- 使用 [作为 Docker 容器](#作为-docker-容器) 中描述的 Docker 镜像。
135+
- 从源码构建:
180136

181137
```bash
182138
cd cmd/godns # 进入 GoDNS 目录
183139
go mod download # 获取依赖项
184140
go build # 构建
185141
```
186142

187-
您还可以从 [releases](https://github.com/TimothyYe/godns/releases) 下载已编译的二进制文件。
188-
189143
## 使用方法
190144

191145
通过运行以下命令打印使用/帮助信息:

0 commit comments

Comments
 (0)