# 雨飏001 · 密钥说明目录

> 版本: v0.1 · 更新: 2026-08-29
> 目的: 说明需要哪些密钥、用途场景，**不上传真实值**

## 使用规则

1. 此目录下所有文件**只说明用途，不写真实值**
2. 真实值通过环境变量注入（`${VAR_NAME}` 占位）
3. 初始化时通过 `bootstrap.sh` 交互式提示录入
4. 真实密钥文件（.env, *.pem, credentials.json）被 .gitignore 排除

## 密钥总览

| 编号 | 密钥名 | 用途 | 来源 | 获取方式 |
|------|--------|------|------|---------|
| K01 | `FMODE_API_KEY` | Fmode API 调用（VOC/模型/FmodeCode） | Fmode API 后台 | 登录 dashboard 获取 |
| K02 | `CLOUD_SDK_AK/SK` | 华为云 OBS/CDN 操作 | nkkj 账号 | 华为云 IAM 用户 |
| K03 | `S3_HW_ACCESS_KEY/SECRET_KEY` | storage-s3 桶访问 | nkkj 账号 | 同 K02 |
| K04 | `FMODE_PARSE_SESSION_TOKEN` | Parse 平台会话 | Fmode Studio 登录 | 登录后获取 |
| K05 | `WECOM_BOT_ID/SECRET` | 企微智能机器人 | 企微后台 | 应用管理页 |
| K06 | `DNSPOD_SECRET_ID/SECRET_KEY` | DNS 域名解析 | DNSPod 控制台 | CloudProvider 表 |
| K07 | `GIT_SSH_KEY` | Git 仓库 SSH 免密 | GitHub/git.fmode.cn | 生成并上传公钥 |
| K08 | `GITHUB_TOKEN` | GitHub API 操作 | GitHub Settings | 生成 Personal Token |
| K09 | `FANQIE_COOKIE` | 番茄小说作家后台 | 浏览器登录 | 登录后导出 Cookie |
| K10 | `EMAIL_PASSWORD` | 网易邮箱登录 | 网易邮箱 | 邮箱设置获取 |
| K11 | `HUAWEI_AGC_SECRET` | 华为 AGC 登录 | 华为开发者后台 | 短信验证码登录 |
| K12 | `FMODE_API_TOKEN` | fmode-listen 转写 | Fmode API 后台 | 同 K01 |

## 密钥分类

### 基础设施
- K01: FMODE_API_KEY — Fmode 平台核心访问凭证
- K02: CLOUD_SDK_AK/SK — 华为云 OBS/CDN/计算资源
- K03: S3_HW_ACCESS_KEY/SECRET_KEY — 私密存储桶

### 沟通通道
- K05: WECOM_BOT_ID/SECRET — 企微智能机器人
- K10: EMAIL_PASSWORD — 网易邮箱

### 开发部署
- K04: FMODE_PARSE_SESSION_TOKEN — Parse 平台
- K06: DNSPOD_SECRET_ID/SECRET_KEY — DNS 解析
- K07: GIT_SSH_KEY — 代码仓库
- K08: GITHUB_TOKEN — GitHub 发布

### 内容创作
- K09: FANQIE_COOKIE — 番茄小说发布
- K11: HUAWEI_AGC_SECRET — 华为手表开发
- K12: FMODE_API_TOKEN — 语音转写

## 环境变量模板

创建 `.env` 文件（被 .gitignore 排除，不上传）：

```bash
# Fmode 核心
export FMODE_API_KEY="your_key_here"
export FMODE_API_TOKEN="$FMODE_API_KEY"

# 华为云(nkkj)
export CLOUD_SDK_AK="2BFF7JWXAIJ0UGNJ0OSB"
export CLOUD_SDK_SK="your_sk_here"
export S3_HW_ACCESS_KEY="$CLOUD_SDK_AK"
export S3_HW_SECRET_KEY="$CLOUD_SDK_SK"

# 企微机器人
export WECOM_BOT_ID="your_bot_id"
export WECOM_SECRET="your_secret"

# Git
export GIT_SSH_KEY_PATH="$HOME/.ssh/id_ed25519"
```

> 注意: 以上模板中 `your_...` 需要替换为真实值，**不要**将填充后的 .env 提交到 Git。