docs: add proxy config and API retry guide in faq

Ljzd-PRO · Oct 26, 2024 · e3cc7f5 · e3cc7f5
1 parent 483560a
commit e3cc7f5
Show file tree

Hide file tree

Showing 2 changed files with 136 additions and 2 deletions.
diff --git a/docs/en/faq.md b/docs/en/faq.md
@@ -45,4 +45,71 @@ KTOOLBOX_JOB__SEQUENTIAL_FILENAME=True
 
 # Set the post directory name to its release/publish date and ID, e.g. `[2024-1-1]11223344`
 KTOOLBOX_JOB__POST_DIRNAME_FORMAT=[{published}]{id}
-```
+```
+
+## How to Configure a Proxy?
+
+You can set the `HTTPS_PROXY`, `HTTP_PROXY`, and `ALL_PROXY` environment variables to achieve this.
+
+Refer to: [HTTPX - Environment Variables](https://www.python-httpx.org/environment_variables/#http_proxy-https_proxy-all_proxy)
+
+For example, set it like this:
+
+```shell
+# Unix Shell
+export HTTPS_PROXY=http://127.0.0.1:7897
+export HTTP_PROXY=http://127.0.0.1:7897
+export ALL_PROXY=socks5://127.0.0.1:7897
+```
+
+```powershell
+# Windows PowerShell
+$env:HTTP_PROXY="http://127.0.0.1:7897"; $env:HTTPS_PROXY="http://127.0.0.1:7897"
+```
+
+## GUI Configuration Editor Cannot Be Opened
+
+!!! warning "Note"
+    [`ktoolbox-pure-py`](https://pypi.org/project/ktoolbox-pure-py/) does not support the graphical configuration editor.
+
+By default, the dependencies for the graphical configuration editor are not installed. You can install them using the following command:
+
+```shell
+pip3 install ktoolbox[urwid]
+```
+
+If you are using pipx:
+
+```shell
+pipx install ktoolbox[urwid] --force
+```
+
+## Kemono API Call Failed
+
+For example:
+
+```
+ktoolbox sync-creator "https://coomer.su/onlyfans/user/hollyharper11" --start-time="2020-05-01" --end-time="2025-01-01"
+
+2024-05-12 12:52:51.477 | INFO     | ktoolbox.cli:sync_creator:271 - Got creator information - {'name': 'hollyharper11', 'id': 'hollyharper11'}
+2024-05-12 12:52:51.479 | INFO     | ktoolbox.action.job:create_job_from_creator:148 - Start fetching posts from creator hollyharper11
+2024-05-12 12:52:56.477 | ERROR    | ktoolbox.api.base:_retry_error_callback:37 - Kemono API call failed - {'ret': APIRet(code=1002, message="1 validation error for Response\n  Invalid JSON: expected value at line 1 column 1 [type=json_invalid, input_value='<!DOCTYPE html>\\n<html>\\...>\\n  </body>\\n</html>\\n', input_type=str]\n    For further information visit https://errors.pydantic.dev/2.7/v/json_invalid", exception=1 validation error for Response
+  Invalid JSON: expected value at line 1 column 1 [type=json_invalid, input_value='<!DOCTYPE html>\n<html>\...>\n  </body>\n</html>\n', input_type=str]
+    For further information visit https://errors.pydantic.dev/2.7/v/json_invalid, data=None)}
+1 validation error for Response
+  Invalid JSON: expected value at line 1 column 1 [type=json_invalid, input_value='<!DOCTYPE html>\n<html>\...>\n  </body>\n</html>\n', input_type=str]
+    For further information visit https://errors.pydantic.dev/2.7/v/json_invalid
+```
+
+This is generally caused by frequent requests, so you can try setting a higher number of API retry attempts.
+
+```dotenv
+# .env / prod.env
+KTOOLBOX_API__RETRY_TIMES=10
+```
+
+You can also set this through the graphical configuration editor: API - retry_times.
+
+## Others
+
+A community-shared usage guide: [#141](https://github.com/Ljzd-PRO/KToolBox/issues/141)
diff --git a/docs/zh/faq.md b/docs/zh/faq.md
@@ -42,4 +42,71 @@ KTOOLBOX_JOB__SEQUENTIAL_FILENAME=True
 
 # 设置作品目录名为其发布日期和ID，例如 `[2024-1-1]11223344`
 KTOOLBOX_JOB__POST_DIRNAME_FORMAT=[{published}]{id}
-```
+```
+
+## 如何配置代理？
+
+可以通过设置 `HTTPS_PROXY`, `HTTP_PROXY`, `ALL_PROXY` 环境变量实现
+
+参考：[HTTPX - Environment Variables](https://www.python-httpx.org/environment_variables/#http_proxy-https_proxy-all_proxy)
+
+例如这样设置：
+
+```shell
+# Unix Shell
+export HTTPS_PROXY=http://127.0.0.1:7897
+export HTTP_PROXY=http://127.0.0.1:7897
+export ALL_PROXY=socks5://127.0.0.1:7897
+```
+
+```powershell
+# Windows PowerShell
+$env:HTTP_PROXY="http://127.0.0.1:7897"; $env:HTTPS_PROXY="http://127.0.0.1:7897"
+```
+
+## 图形化配置编辑器无法打开
+
+!!! warning "注意"
+    [`ktoolbox-pure-py`](https://pypi.org/project/ktoolbox-pure-py/) 不支持图形化配置编辑器
+
+默认情况下，图形化配置编辑器的相关依赖不会被安装，可使用以下命令附带安装：
+
+```shell
+pip3 install ktoolbox[urwid]
+```
+
+如果你用的是 pipx：
+
+```shell
+pipx install ktoolbox[urwid] --force
+```
+
+## Kemono API 调用失败
+
+例如：
+
+```
+ktoolbox sync-creator "https://coomer.su/onlyfans/user/hollyharper11" --start-time="2020-05-01" --end-time="2025-01-01"
+
+2024-05-12 12:52:51.477 | INFO     | ktoolbox.cli:sync_creator:271 - Got creator information - {'name': 'hollyharper11', 'id': 'hollyharper11'}
+2024-05-12 12:52:51.479 | INFO     | ktoolbox.action.job:create_job_from_creator:148 - Start fetching posts from creator hollyharper11
+2024-05-12 12:52:56.477 | ERROR    | ktoolbox.api.base:_retry_error_callback:37 - Kemono API call failed - {'ret': APIRet(code=1002, message="1 validation error for Response\n  Invalid JSON: expected value at line 1 column 1 [type=json_invalid, input_value='<!DOCTYPE html>\\n<html>\\...>\\n  </body>\\n</html>\\n', input_type=str]\n    For further information visit https://errors.pydantic.dev/2.7/v/json_invalid", exception=1 validation error for Response
+  Invalid JSON: expected value at line 1 column 1 [type=json_invalid, input_value='<!DOCTYPE html>\n<html>\...>\n  </body>\n</html>\n', input_type=str]
+    For further information visit https://errors.pydantic.dev/2.7/v/json_invalid, data=None)}
+1 validation error for Response
+  Invalid JSON: expected value at line 1 column 1 [type=json_invalid, input_value='<!DOCTYPE html>\n<html>\...>\n  </body>\n</html>\n', input_type=str]
+    For further information visit https://errors.pydantic.dev/2.7/v/json_invalid
+```
+
+一般可能是因为请求频繁导致，你可以尝试设置更多的 API 重试次数
+
+```dotenv
+# .env / prod.env
+KTOOLBOX_API__RETRY_TIMES=10
+```
+
+你也可以通过图形化配置编辑器设置：API - retry_times
+
+## 其他
+
+一个社区分享的使用向导：[#141](https://github.com/Ljzd-PRO/KToolBox/issues/141)