add comments for pages

go-gost · Dec 1, 2023 · 59913df · 59913df
1 parent 9b60412
commit 59913df
Show file tree

Hide file tree

Showing 43 changed files with 175 additions and 5 deletions.
diff --git a/docs/tutorials/api/config.md b/docs/tutorials/api/config.md
@@ -1,3 +1,7 @@
+---
+comments: true
+---
+
 # 动态配置
 
 GOST可以通过Web API来进行动态配置，支持动态配置的对象有：服务(Service)，转发链(Chain)，认证器(Auther)，分流器(Bypass)，准入控制器(Admission)，域名解析器(Resolver)，域名IP映射器(Hosts)，限速器(Limiter)。配置变更会立即生效。

diff --git a/docs/tutorials/api/overview.md b/docs/tutorials/api/overview.md
@@ -1,3 +1,7 @@
+---
+comments: true
+---
+
 # Web API
 
 GOST可以通过开启Web API服务使用RESTful API和GOST进程进行交互。

diff --git a/docs/tutorials/dns.md b/docs/tutorials/dns.md
@@ -1,3 +1,7 @@
+---
+comments: true
+---
+
 # DNS代理
 
 与域名解析器类似，DNS代理服务支持多种协议类型，支持自定义域名解析(映射器)，具有缓存功能，并支持转发链。

diff --git a/docs/tutorials/file.md b/docs/tutorials/file.md
@@ -1,3 +1,7 @@
+---
+comments: true
+---
+
 # HTTP文件服务
 
 HTTP文件服务，将本地的文件系统目录转成HTTP服务。

diff --git a/docs/tutorials/http-tunnel.md b/docs/tutorials/http-tunnel.md
@@ -1,3 +1,7 @@
+---
+comments: true
+---
+
 # HTTP数据通道
 
 HTTP是目前互联网上使用最广泛的一种数据交换协议，随着互联网的发展，协议也进行了几次重大的版本升级，从最原始的HTTP/1到HTTP/2，再到现在的基于QUIC协议的HTTP/3。

diff --git a/docs/tutorials/icmp.md b/docs/tutorials/icmp.md
@@ -1,3 +1,7 @@
+---
+comments: true
+---
+
 # ICMP通道
 
 [ICMP](https://en.wikipedia.org/wiki/Internet_Control_Message_Protocol)通道是利用ICMP协议的Echo类型报文(ping命令所采用)进行数据传输。由于ICMP类似于UDP，是一种不可靠的协议，存在丢包和乱序情况，因此不能直接用于流式数据传输。GOST在ICMP之上利用QUIC协议来实现安全可靠的数据传输，因此ICMP通道可以看作是QUIC-over-ICMP数据通道。

diff --git a/docs/tutorials/log.md b/docs/tutorials/log.md
@@ -1,3 +1,7 @@
+---
+comments: true
+---
+
 # 日志
 
 全局默认日志记录通过`log`选项配置。

diff --git a/docs/tutorials/metrics.md b/docs/tutorials/metrics.md
@@ -1,3 +1,7 @@
+---
+comments: true
+---
+
 # 监控指标
 
 GOST内部通过[Prometheus](https://prometheus.io/)的指标(Metrics)来提供监控数据。

diff --git a/docs/tutorials/multi-homed.md b/docs/tutorials/multi-homed.md
@@ -1,3 +1,7 @@
+---
+comments: true
+---
+
 # 多网络接口
 
 当主机具有多个网络接口(Multi-homed host)时，可以根据需要对不同服务的路由指定不同的网络出口。

diff --git a/docs/tutorials/port-forwarding.md b/docs/tutorials/port-forwarding.md
@@ -1,3 +1,7 @@
+---
+comments: true
+---
+
 # 端口转发
 
 端口转发根据协议类型分为TCP和UDP端口转发，根据转发类型又分为本地转发和远程转发，总共有四种组合。

diff --git a/docs/tutorials/probe-resistance.md b/docs/tutorials/probe-resistance.md
@@ -1,3 +1,7 @@
+---
+comments: true
+---
+
 # 探测防御
 
 GOST对HTTP/HTTPS/HTTP2代理提供了探测防御功能。当代理服务收到非法请求时，会按照探测防御策略返回对应的响应内容。

diff --git a/docs/tutorials/proxy-protocol.md b/docs/tutorials/proxy-protocol.md
@@ -1,3 +1,7 @@
+---
+comments: true
+---
+
 # PROXY Protocol
 
 GOST服务支持接收代理协议头(PROXY protocol v1/v2)，当服务处于其他代理服务(例如Nginx)后面时，通过代理协议用于获取客户端真实IP。

diff --git a/docs/tutorials/redirect.md b/docs/tutorials/redirect.md
@@ -1,3 +1,7 @@
+---
+comments: true
+---
+
 # 透明代理
 
 透明代理支持REDIRECT和TPROXY两种方式，REDIRECT方式仅支持TCP。

diff --git a/docs/tutorials/reverse-proxy-tunnel-ha.md b/docs/tutorials/reverse-proxy-tunnel-ha.md
@@ -1,3 +1,7 @@
+---
+comments: true
+---
+
 # 反向代理隧道-高可用
 
 在上一篇[反向代理隧道](/tutorials/reverse-proxy-tunnel/)教程中，详细的讲述了反向代理隧道的功能和使用方法。在本篇教程中将侧重于服务的部署及系统的高可用性方面。

diff --git a/docs/tutorials/reverse-proxy-tunnel.md b/docs/tutorials/reverse-proxy-tunnel.md
@@ -1,3 +1,7 @@
+---
+comments: true
+---
+
 # 反向代理隧道
 
 在上一篇[反向代理](/tutorials/reverse-proxy/)教程中，利用端口转发实现了简单的反向代理功能，在本篇中将利用隧道服务实现类似于[Cloudflare Tunnel](https://developers.cloudflare.com/cloudflare-one/connections/connect-apps/)的增强版反向代理。

diff --git a/docs/tutorials/reverse-proxy.md b/docs/tutorials/reverse-proxy.md
@@ -1,3 +1,7 @@
+---
+comments: true
+---
+
 # 反向代理
 
 [反向代理](https://zh.wikipedia.org/wiki/%E5%8F%8D%E5%90%91%E4%BB%A3%E7%90%86)是代理服务的一种。服务器根据客户端的请求，从其关系的一组或多组后端服务器（如Web服务器）上获取资源，然后再将这些资源返回给客户端，客户端只会得知反向代理的IP地址，而不知道在代理服务器后面的服务器集群的存在。

diff --git a/docs/tutorials/serial.md b/docs/tutorials/serial.md
@@ -1,3 +1,7 @@
+---
+comments: true
+---
+
 # 串口重定向
 
 串口重定向可以将本地的串口设备重定向到一个TCP服务或另外一个串口设备，转发链在这种场景下依然有效。

diff --git a/docs/tutorials/tls.md b/docs/tutorials/tls.md
@@ -1,3 +1,7 @@
+---
+comments: true
+---
+
 # TLS
 
 GOST有三种类型TLS证书：自生成证书，全局证书，服务层级证书。

diff --git a/docs/tutorials/tuntap.md b/docs/tutorials/tuntap.md
@@ -1,3 +1,7 @@
+---
+comments: true
+---
+
 # TUN/TAP设备
 
 ## TUN

diff --git a/docs/tutorials/unix.md b/docs/tutorials/unix.md
@@ -1,3 +1,7 @@
+---
+comments: true
+---
+
 # Unix Domain Socket重定向
 
 UDS(Unix Domain Socket)重定向可以将本地的UDS服务重定向到一个TCP服务或另外一个UDS服务，转发链在这种场景下依然有效。

diff --git a/en/docs/tutorials/api/config.md b/en/docs/tutorials/api/config.md
@@ -1,3 +1,7 @@
+---
+comments: true
+---
+
 # Dynamic configuration
 
 GOST can be dynamically configured through Web API. The objects that support dynamic configuration are: service, chain, auther, bypass, admission controller, resolver, hosts. Configuration changes take effect immediately.

diff --git a/en/docs/tutorials/api/overview.md b/en/docs/tutorials/api/overview.md
@@ -1,3 +1,7 @@
+---
+comments: true
+---
+
 # Web API
 
 GOST can use the RESTful API to interact with the GOST process by starting the Web API service.

diff --git a/en/docs/tutorials/dns.md b/en/docs/tutorials/dns.md
@@ -1,3 +1,7 @@
+---
+comments: true
+---
+
 # DNS Proxy
 
 Similar to the domain name resolver, the DNS proxy service supports multiple protocol types, supports custom domain name resolution (host mapper), has a caching function, and supports forwarding chains.

diff --git a/en/docs/tutorials/file.md b/en/docs/tutorials/file.md
@@ -1,3 +1,7 @@
+---
+comments: true
+---
+
 # HTTP File Server
 
 HTTP file server converts the local file system directory into an HTTP server.

diff --git a/en/docs/tutorials/http-tunnel.md b/en/docs/tutorials/http-tunnel.md
@@ -1,3 +1,7 @@
+---
+comments: true
+---
+
 # HTTP Tunnel
 
 HTTP is the most widely used data exchange protocol on the Internet. With the development of the Internet, the protocol has undergone several major version upgrades, from the original HTTP/1 to HTTP/2, and then to the current QUIC-based protocol HTTP/3.

diff --git a/en/docs/tutorials/icmp.md b/en/docs/tutorials/icmp.md
@@ -1,3 +1,7 @@
+---
+comments: true
+---
+
 # ICMP Tunnel
 
 The [ICMP](https://en.wikipedia.org/wiki/Internet_Control_Message_Protocol) tunnel uses the Echo type message of the ICMP protocol (used by the ping command) for data transmission. Since ICMP is similar to UDP, it is an unreliable protocol with packet loss and disorder, so it cannot be directly used for streaming data transmission. GOST uses the QUIC protocol on top of ICMP to achieve secure and reliable data transmission, so the ICMP tunnel can be regarded as a QUIC-over-ICMP data tunnel.

diff --git a/en/docs/tutorials/log.md b/en/docs/tutorials/log.md
@@ -1,3 +1,7 @@
+---
+comments: true
+---
+
 # Log
 
 Global default logging is configured via the `log` option.

diff --git a/en/docs/tutorials/metrics.md b/en/docs/tutorials/metrics.md
@@ -1,3 +1,7 @@
+---
+comments: true
+---
+
 # Prometheus Metrics
 
 GOST internally provides monitoring data through the [Prometheus](https://prometheus.io/) metrics.

diff --git a/en/docs/tutorials/multi-homed.md b/en/docs/tutorials/multi-homed.md
@@ -1,3 +1,7 @@
+---
+comments: true
+---
+
 # Multi-homed Hosts
 
 Hosts that have more than one network interface usually have one Internet Protocol (IP) address for each interface. Such hosts are called multi-homed hosts.

diff --git a/en/docs/tutorials/port-forwarding.md b/en/docs/tutorials/port-forwarding.md
@@ -1,3 +1,7 @@
+---
+comments: true
+---
+
 # Port Forwarding
 
 Port forwarding is divided into TCP and UDP port forwarding according to the protocol type, and local forwarding and remote forwarding according to the forwarding type. There are four combinations in total.
@@ -9,9 +13,11 @@ Port forwarding is divided into TCP and UDP port forwarding according to the pro
 You can set a single forwarding destination address for one-to-one port forwarding:
 
 === "CLI"
+
 	```bash
 	gost -L tcp://:8080/192.168.1.1:80
 	```
+
 === "File (YAML)"
 
     ```yaml

diff --git a/en/docs/tutorials/probe-resistance.md b/en/docs/tutorials/probe-resistance.md
@@ -1,3 +1,7 @@
+---
+comments: true
+---
+
 # Probing Resistance
 
 GOST provides probing resistance for the HTTP/HTTPS/HTTP2 proxies. When the proxy server receives an invalid request, it will return the corresponding response according to the probing resistance policy.
@@ -6,9 +10,11 @@ GOST provides probing resistance for the HTTP/HTTPS/HTTP2 proxies. When the prox
     The probing resistance feature is only valid when the proxy server has user authentication enabled.
 
 === "CLI"
-    ```
+
+    ```bash
     gost -L=http://gost:gost@:8080?probeResistance=code:400&knock=www.example.com
     ```
+
 === "File (YAML)"
 
     ```yaml

diff --git a/en/docs/tutorials/proxy-protocol.md b/en/docs/tutorials/proxy-protocol.md
@@ -1,10 +1,14 @@
+---
+comments: true
+---
+
 # PROXY Protocol
 
 The GOST service supports the receiving PROXY protocol(v1/v2). When the service is behind other proxy service (such as Nginx), the PROXY protocol is used to obtain the real IP of the client.
 
 === "CLI"
 
-    ```
+    ```bash
     gost -L=:8080?proxyProtocol=1
     ```
 

diff --git a/en/docs/tutorials/redirect.md b/en/docs/tutorials/redirect.md
@@ -1,3 +1,7 @@
+---
+comments: true
+---
+
 # Transparent Proxy
 
 Transparent proxy supports two modes: REDIRECT and TPROXY. The REDIRECT mode only supports TCP.
@@ -17,9 +21,11 @@ Transparent proxy using REDIRECT can choose to mark packets. Using Mark requires
 ### Without Mark
 
 === "CLI"
-    ```
+
+    ```bash
     gost -L red://:12345?sniffing=true -F 192.168.1.1:1080
     ```
+
 === "File (YAML)"
 
     ```yaml

diff --git a/en/docs/tutorials/relay.md b/en/docs/tutorials/relay.md
@@ -1,3 +1,7 @@
+---
+comments: true
+---
+
 # Relay Protocol
 
 The Relay protocol is a GOST proprietary protocol with both proxy and forwarding functions, which can process TCP and UDP data at the same time, and supports user authentication.

diff --git a/en/docs/tutorials/reverse-proxy-tunnel-ha.md b/en/docs/tutorials/reverse-proxy-tunnel-ha.md
@@ -1,3 +1,7 @@
+---
+comments: true
+---
+
 # Reverse Proxy Tunnel - High Availability
 
 In the previous [Reverse Proxy Tunnel](/en/tutorials/reverse-proxy-tunnel/) tutorial, the functions and usage of reverse proxy tunnels were described in detail. In this tutorial, we will focus on the deployment and the high availability of the system.

diff --git a/en/docs/tutorials/reverse-proxy-tunnel.md b/en/docs/tutorials/reverse-proxy-tunnel.md
@@ -1,3 +1,7 @@
+---
+comments: true
+---
+
 # Reverse Proxy Tunnel
 
 In the previous [Reverse Proxy](/en/tutorials/reverse-proxy/) tutorial, port forwarding was used to implement a simple reverse proxy function. In this article, we will implement an enhanced reverse proxy similar to [Cloudflare Tunnel](https://developers.cloudflare.com/cloudflare-one/connections/connect-apps/).

diff --git a/en/docs/tutorials/reverse-proxy.md b/en/docs/tutorials/reverse-proxy.md
@@ -1,3 +1,7 @@
+---
+comments: true
+---
+
 # Reverse Proxy
 
 [Reverse Proxy](https://en.wikipedia.org/wiki/Reverse_proxy) is a type of proxy service. According to the client's request, the server obtains resources from one or more groups of backend servers (such as web servers) related to it, and then returns these resources to the client. The client only knows the IP address of the reverse proxy, without knowing the existence of server clusters behind proxy servers.

diff --git a/en/docs/tutorials/serial.md b/en/docs/tutorials/serial.md
@@ -1,3 +1,7 @@
+---
+comments: true
+---
+
 # Serial Port Redirector
 
 Serial port redirector can redirect the local serial port device to a TCP service or another serial port device. The forwarding chain is still valid in this scenario.

diff --git a/en/docs/tutorials/tls.md b/en/docs/tutorials/tls.md
@@ -1,3 +1,7 @@
+---
+comments: true
+---
+
 # TLS
 
 GOST has three types of TLS certificates: self-generated certificate, global certificate, and service-level certificate.

diff --git a/en/docs/tutorials/tuntap.md b/en/docs/tutorials/tuntap.md
@@ -1,3 +1,7 @@
+---
+comments: true
+---
+
 # TUN/TAP Device
 
 ## TUN

diff --git a/en/docs/tutorials/unix.md b/en/docs/tutorials/unix.md
@@ -1,3 +1,7 @@
+---
+comments: true
+---
+
 # Unix Domain Socket Redirector
 
 UDS(Unix Domain Socket) redirector can redirect the local UDS service to a TCP service or another UDS service. The forwarding chain is still valid in this scenario.

diff --git a/en/mkdocs.yml b/en/mkdocs.yml
@@ -83,7 +83,7 @@ markdown_extensions:
       custom_checkbox: true
   - pymdownx.tilde
 
-copyright: Copyright &copy; 2015 - 2022 GOST
+copyright: Copyright &copy; 2015 - 2024 GOST
 
 nav:
   - Welcome: index.md

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -92,7 +92,7 @@ markdown_extensions:
       custom_checkbox: true
   - pymdownx.tilde
 
-copyright: Copyright &copy; 2015 - 2022 GOST
+copyright: Copyright &copy; 2015 - 2024 GOST
 
 nav:
   - 主页: index.md