1041006580 commited on
Commit
af43cc9
·
1 Parent(s): dada8a9

docs: 添加HuggingFace Spaces部署和Admin配置说明

Browse files
Files changed (1) hide show
  1. README.md +38 -0
README.md CHANGED
@@ -340,6 +340,44 @@ kiro-rs/
340
  Authorization: Bearer sk-your-api-key
341
  ```
342
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
343
  ## 环境变量
344
 
345
  可通过环境变量配置日志级别:
 
340
  Authorization: Bearer sk-your-api-key
341
  ```
342
 
343
+ ## HuggingFace Spaces 部署
344
+
345
+ 本项目支持部署到 HuggingFace Spaces。通过环境变量配置:
346
+
347
+ ### 必需的环境变量
348
+
349
+ | 变量名 | 说明 | 示例 |
350
+ |--------|------|------|
351
+ | `REFRESH_TOKEN` | Kiro 刷新令牌 | `your-refresh-token` |
352
+ | `API_KEY` | API 访问密钥 | `sk-kiro-rs-your-key` |
353
+
354
+ ### 可选的环境变量
355
+
356
+ | 变量名 | 说明 | 默认值 |
357
+ |--------|------|--------|
358
+ | `REGION` | AWS 区域 | `us-east-1` |
359
+ | `EXPIRES_AT` | Token 过期时间 | `2020-01-01T00:00:00.000Z` |
360
+ | `AUTH_METHOD` | 认证方式 (social/idc) | `social` |
361
+ | `CLIENT_ID` | IdC 客户端 ID(仅 idc 模式) | - |
362
+ | `CLIENT_SECRET` | IdC 客户端密钥(仅 idc 模式) | - |
363
+ | `ADMIN_API_KEY` | Admin API 密钥(启用管理界面) | - |
364
+
365
+ ### 启用 Admin 管理界面
366
+
367
+ 在 HuggingFace Space 的 Settings → Variables 中添加:
368
+ - `ADMIN_API_KEY`: 设置一个安全的密钥(如 `sk-admin-your-secret-key`)
369
+
370
+ 启用后可访问:
371
+ - Admin UI: `https://your-space.hf.space/admin`
372
+ - Admin API: `https://your-space.hf.space/api/admin/*`
373
+
374
+ 通过 Admin 界面可以:
375
+ - 查看所有凭据状态
376
+ - 动态添加/删除凭据
377
+ - 调整凭据优先级
378
+ - 启用/禁用凭据
379
+ - 查看余额信息
380
+
381
  ## 环境变量
382
 
383
  可通过环境变量配置日志级别: