From 23ff8e1c8d5d019888e7f6ed5eeeb06cf1f98ba9 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=E7=B2=92=E7=B2=92=E6=A9=99?= <i@llc.moe>
Date: Thu, 7 May 2020 13:05:05 +0800
Subject: [PATCH] update docs

---
 conf/conf.go                     |   1 -
 conf/parse.go                    |   1 -
 docs/content/basic/fullconfig.md | 167 ++++++++++++++++---------------
 3 files changed, 85 insertions(+), 84 deletions(-)

diff --git a/conf/conf.go b/conf/conf.go
index c2f37c0..599ea2e 100644
--- a/conf/conf.go
+++ b/conf/conf.go
@@ -86,7 +86,6 @@ type RedisConfig struct {
 	ServerHost string `json:"server_addr"`
 	ServerPort int    `json:"server_port"`
 	Password   string `json:"password"`
-	CheckRate  int    `json:"check_rate"`
 }
 
 type ForwardProxyConfig struct {
diff --git a/conf/parse.go b/conf/parse.go
index 95fb78b..fc93bcd 100644
--- a/conf/parse.go
+++ b/conf/parse.go
@@ -330,7 +330,6 @@ func ParseJSON(data []byte) (*GlobalConfig, error) {
 	config.Redis.ServerHost = "localhost"
 	config.Redis.ServerPort = 6379
 	config.Redis.Password = ""
-	config.Redis.CheckRate = 60
 
 	err := json.Unmarshal(data, config)
 	if err != nil {
diff --git a/docs/content/basic/fullconfig.md b/docs/content/basic/fullconfig.md
index f14ec16..c58046e 100644
--- a/docs/content/basic/fullconfig.md
+++ b/docs/content/basic/fullconfig.md
@@ -22,89 +22,92 @@ weight: 30
 
 其余未填的选项，用下面给出的值进行填充。
 
-```
+```json
 {
-    "run_type": "client/server/nat",
-    "local_addr": "127.0.0.1",
-    "local_port":  your_port1,
-    "remote_addr": "example.com",
-    "remote_port": your_port2,
-    "log_level": 1,
-    "log_file": "",
-    "password": [
-        "password1",
-        "password2"
-    ],
-    "buffer_size": 32,
-    "dns": [],
-    "ssl": {
-        "verify": true,
-        "verify_hostname": true,
-        "cert": "your_crt_file(optional for a client/forward/nat)",
-        "key": "your_key_file(optional for a client/forward/nat)",
-        "key_password": "",
-        "cipher": "",
-        "cipher_tls13": "",
-        "curves": "",
-        "prefer_server_cipher": false,
-        "sni": "",
-        "alpn": [],
-        "session_ticket": true,
-        "reuse_session": true,
-        "plain_http_response": "",
-        "fallback_port": 0,
-        "fingerprint": ""
-    },
-    "tcp": {
-        "no_delay": true,
-        "keep_alive": true,
-        "reuse_port": false,
-        "prefer_ipv4": false,
-        "fast_open": false,
-        "fast_open_qlen": 20
-    },
-    "mux": {
-        "enabled": false,
-        "concurrency": 8,
-        "idle_timeout": 60
-    },
-    "router": {
-        "enabled": false,
-        "bypass": [],
-        "proxy": [],
-        "block": [],
-        "route_by_ip": false,
-        "route_by_ip_on_nonmatch": false,
-        "default_policy": "proxy"
-    },
-    "websocket": {
-        "enabled": false,
-        "path": "",
-        "hostname": "",
-        "obfuscation_password": "",
-        "double_tls": true
-    },
-    "forward_proxy": {
-        "enabled": false,
-        "proxy_addr": "",
-        "proxy_port": 0,
-        "username": "",
-        "password": ""
-    },
-    "mysql": {
-        "enabled": false,
-        "server_addr": "",
-        "server_port": 0,
-        "database": "",
-        "username": "",
-        "password": "",
-        "check_rate": 60
-    },
-    "api": {
-        "enabled": true,
-        "api_addr": "",
-        "api_port": 0
-    }
+  "run_type": *required*,
+  "local_addr": *required*,
+  "local_port": *required*,
+  "remote_addr": *required*,
+  "remote_port": *required*,
+  "log_level": 1,
+  "log_file": "",
+  "password": [],
+  "buffer_size": 32,
+  "dns": [],
+  "ssl": {
+    "verify": true,
+    "verify_hostname": true,
+    "cert": *required*,
+    "key": *required*,
+    "key_password": "",
+    "cipher": "",
+    "cipher_tls13": "",
+    "curves": "",
+    "prefer_server_cipher": false,
+    "sni": "",
+    "alpn": [],
+    "session_ticket": true,
+    "reuse_session": true,
+    "plain_http_response": "",
+    "fallback_port": 0,
+    "fingerprint": ""
+  },
+  "tcp": {
+    "no_delay": true,
+    "keep_alive": true,
+    "reuse_port": false,
+    "prefer_ipv4": false,
+    "fast_open": false,
+    "fast_open_qlen": 20
+  },
+  "mux": {
+    "enabled": false,
+    "concurrency": 8,
+    "idle_timeout": 60
+  },
+  "router": {
+    "enabled": false,
+    "bypass": [],
+    "proxy": [],
+    "block": [],
+    "route_by_ip": false,
+    "route_by_ip_on_nonmatch": false,
+    "default_policy": "proxy"
+  },
+  "websocket": {
+    "enabled": false,
+    "path": "",
+    "hostname": "",
+    "obfuscation_password": "",
+    "double_tls": true
+  },
+  "forward_proxy": {
+    "enabled": false,
+    "proxy_addr": "",
+    "proxy_port": 0,
+    "username": "",
+    "password": ""
+  },
+  "mysql": {
+    "enabled": false,
+    "server_addr": "",
+    "server_port": 0,
+    "database": "",
+    "username": "",
+    "password": "",
+    "check_rate": 60
+  },
+  "redis": {
+    "enabled": false,
+    "server_addr": "localhost",
+    "server_port": 6379,
+    "password": ""
+  },
+  "api": {
+    "enabled": true,
+    "api_addr": "",
+    "api_port": 0
+  }
 }
 ```