docs: update download config

GopeedLab · Aug 9, 2024 · 88ab3bc · 88ab3bc
1 parent 0972b1a
commit 88ab3bc
Show file tree

Hide file tree

Showing 3 changed files with 43 additions and 1 deletion.
diff --git a/docs/install.md b/docs/install.md
@@ -103,13 +103,27 @@ It also supports configuration through configuration files. Create a `config.jso
   "port": 0, // Bind port (default 9999)
   "username": "", // HTTP Basic Auth Username (default "gopeed")
   "password": "", // HTTP Basic Auth Password
-  "apiToken": "", // HTTP API token, it must be configured when using HTTP API in the case of enabling identity authentication
+  "apiToken": "", // HTTP API token, it must be configured when using HTTP API in the case of enabling basic authentication
   "storageDir": "" // Storage directory
 }
 ```
 
 > Note: If you are deploying on a public IP, it is recommended to enable identity authentication, otherwise there will be security risks.
 
+#### Default Download Configuration
+
+If you need to set the default download configuration when the server starts for the first time, you can add the `downloadConfig` field in `config.json`. For configuration details, please refer to [DownloaderStoreConfig](https://pkg.go.dev/github.com/GopeedLab/gopeed/pkg/base#DownloaderStoreConfig). Here is an example:
+
+```json
+{
+  "address": "127.0.0.1",
+  "port": 9999,
+  "downloadConfig": {
+    "downloadDir": "d:/test"  // Set the default download directory
+  }
+}
+```
+
 ## Docker
 
 One line of command:

diff --git a/docs/zh-TW/install.md b/docs/zh-TW/install.md
@@ -110,6 +110,20 @@ Usage of C:\Users\levi\Downloads\gopeed-web-v1.3.13-windows-amd64\gopeed.exe:
 
 > 注意：如果你是在公網 ip 部署，建議啟用身份認證，否則會有安全風險。
 
+#### 預設下載配置
+
+如果需要在伺服器首次啟動的時候設定預設下載配置，可以在`config.json`中添加`downloadConfig`欄位，配置詳情參考：[DownloaderStoreConfig](https://pkg.go.dev/github.com/GopeedLab/gopeed/pkg/base#DownloaderStoreConfig)，示例：
+
+```json
+{
+  "address": "127.0.0.1",
+  "port": 9999,
+  "downloadConfig": {
+    "downloadDir": "d:/test"  // 設定預設下載目錄
+  }
+}
+```
+
 ## Docker
 
 直接一行指令即可運行：

diff --git a/docs/zh/install.md b/docs/zh/install.md
@@ -110,6 +110,20 @@ Usage of C:\Users\levi\Downloads\gopeed-web-v1.3.13-windows-amd64\gopeed.exe:
 
 > 注：如果你是在公网 ip 上进行部署，建议启用身份认证，否则会有安全风险。
 
+#### 默认下载配置
+
+如果需要在服务器首次启动的时候设置默认下载配置，可以在`config.json`中添加`downloadConfig`字段，配置详情参考：[DownloaderStoreConfig](https://pkg.go.dev/github.com/GopeedLab/gopeed/pkg/base#DownloaderStoreConfig)，示例：
+
+```json
+{
+  "address": "127.0.0.1",
+  "port": 9999,
+  "downloadConfig": {
+    "downloadDir": "d:/test"  // 设置默认下载目录
+  }
+}
+```
+
 ## Docker
 
 直接一行命令即可运行：