From 1aa568ce45704fbab3d2484ec3b648f2b08aa7ad Mon Sep 17 00:00:00 2001 From: Luis Pater Date: Thu, 9 Oct 2025 23:36:11 +0800 Subject: [PATCH] docs: document `api-keys` usage in README and README_CN - Added explanation and examples for `api-keys` configuration. - Updated both English and Chinese documentation. --- README.md | 5 +++++ README_CN.md | 5 +++++ 2 files changed, 10 insertions(+) diff --git a/README.md b/README.md index a2642b5c..16a3d035 100644 --- a/README.md +++ b/README.md @@ -357,6 +357,11 @@ remote-management: # Authentication directory (supports ~ for home directory). If you use Windows, please set the directory like this: `C:/cli-proxy-api/` auth-dir: "~/.cli-proxy-api" +# API keys for authentication +api-keys: + - "your-api-key-1" + - "your-api-key-2" + # Enable debug logging debug: false diff --git a/README_CN.md b/README_CN.md index b1f9b0f4..8c1fd70f 100644 --- a/README_CN.md +++ b/README_CN.md @@ -368,6 +368,11 @@ remote-management: # 身份验证目录(支持 ~ 表示主目录)。如果你使用Windows,建议设置成`C:/cli-proxy-api/`。 auth-dir: "~/.cli-proxy-api" +# 请求认证使用的API密钥 +api-keys: + - "your-api-key-1" + - "your-api-key-2" + # 启用调试日志 debug: false