Merge pull request #225 from ipfs-force-community/doc/enable-mine-record

doc: enable record
ipfs-force-community · Sep 7, 2023 · 2f507a1 · 2f507a1
2 parents 6459534 + 69884ce
commit 2f507a1
Showing 1 changed file with 21 additions and 1 deletion.
diff --git a/docs/zh/mine-record.md b/docs/zh/mine-record.md
@@ -53,7 +53,27 @@
 
 ### 使用
 
-默认情况下， `sophon-miner` 会记录七天的出块记录。可以使用 cli 查询，和请求接口查询等方式获取出块记录。
+
+ 该功能启用后，`sophon-miner` 会记录七天的出块记录。可以使用 cli 查询，和请求接口查询等方式获取出块记录。
+
+#### 启用
+
+mine recorder 默认是关闭的，可以通过配置文件启用。
+
+```toml
+[Recorder]
+    # 是否启用
+    # 默认 false
+	Enable  = true
+
+    # 记录过期时间
+    # 默认为 7天， 也就是 & * 2880 
+	ExpireEpoch = 0
+
+    # 每次查询的最大记录数
+    # 默认为 288
+	MaxRecordPerQuery = 0
+```
 
 #### 通过 cli 查询出块记录