dekun
83fd9c1fd9
Add click-to-zoom for uploaded images, move manage.sh to deploy/ for curl|bash bootstrap, and remove Windows docs and PowerShell scripts. Co-authored-by: Cursor <cursoragent@cursor.com>
165 lines
5.6 KiB
Markdown
165 lines
5.6 KiB
Markdown
# 使用说明 — crypto_key 凭证保险库
|
||
|
||
本文档介绍日常使用方法。部署与安装请参阅 [DEPLOY.md](./DEPLOY.md)。
|
||
|
||
---
|
||
|
||
## 1. 产品简介
|
||
|
||
**crypto_key** 是一款在浏览器中使用的本地/局域网凭证管理工具，用于集中保存：
|
||
|
||
- 交易所 API（Binance、OKX、Gate）
|
||
- **钱包助记词**、**钱包密钥**（支持图片附件）
|
||
- 网站账号（可点击打开网址）
|
||
- 邮箱账户（可点击发邮件或打开网页登录）
|
||
- 企业微信 / 钉钉机器人 Webhook
|
||
- 微信、QQ（微信号/QQ号 + 手机号）
|
||
- 自定义类型（如小红书、抖音、快手等，在系统设置中自行添加）
|
||
|
||
所有敏感数据在服务器上以 **加密形式** 写入 `data.json`；访问前需 **登录**。浏览器 **不会** 把密码写入 localStorage。
|
||
|
||
| 项目 | 说明 |
|
||
|------|------|
|
||
| 默认端口 | 5200 |
|
||
| 访问方式 | 本机 `http://127.0.0.1:5200` 或局域网 `http://<IP>:5200` |
|
||
|
||
---
|
||
|
||
## 2. 首次登录
|
||
|
||
1. 启动服务后，在浏览器打开上述地址。
|
||
2. 输入 **用户名** 和 **密码**。
|
||
3. 首次部署时，若未配置 `.env`，系统可能自动生成默认账号：
|
||
- 用户名：`admin`
|
||
- 密码：`admin123`
|
||
4. **登录后请立即进入「系统设置 → 账户密码」修改。**
|
||
|
||
> 登录状态保存在服务端 Session（HttpOnly Cookie），关闭浏览器后需重新登录（约 30 分钟无操作也会失效）。
|
||
|
||
---
|
||
|
||
## 3. 界面总览
|
||
|
||
登录后顶部为两个主 Tab：
|
||
|
||
| Tab | 作用 |
|
||
|-----|------|
|
||
| **添加凭证** | 选择类型、填写字段（可含图片）、保存 |
|
||
| **查询凭证** | 类型下拉筛选 + 关键词，确认后展示列表 |
|
||
|
||
右上角：
|
||
|
||
- **系统设置**：账户密码 / 自定义类型 / 备份恢复
|
||
- **退出**：清除登录状态
|
||
|
||
---
|
||
|
||
## 4. 添加凭证
|
||
|
||
1. 切换到 **「添加凭证」** Tab。
|
||
2. 在凭证类型输入框搜索并点击类型（如「钱包助记词」）。
|
||
3. 填写表单；若有图片字段，选择本地图片后会自动上传。
|
||
4. 点击 **「添加」**。成功后建议切到「查询凭证」查看。
|
||
|
||
### 各类型主要字段
|
||
|
||
| 类型 | 主要字段 |
|
||
|------|----------|
|
||
| 交易所 API | 交易所、账户名称、API Key、API Secret；OKX 额外必填密码 |
|
||
| 钱包助记词 | 名称、链/网络、助记词、地址、图片、备注 |
|
||
| 钱包密钥 | 名称、链/网络、私钥、地址、图片、备注 |
|
||
| 网站账号 | 名称、网址、用户名、密码 |
|
||
| 邮箱账户 | 名称、邮箱地址、密码；可选网页登录地址 |
|
||
| 企业微信 / 钉钉机器人 | 名称、Webhook |
|
||
| 微信 / QQ | 名称、微信号或 QQ 号、手机号 |
|
||
| 自定义类型 | 按你在系统设置中定义的字段填写 |
|
||
|
||
---
|
||
|
||
## 5. 查询凭证
|
||
|
||
1. 切换到 **「查询凭证」** Tab。
|
||
2. 在 **类型筛选** 下拉框选择类型（或「全部类型」）。
|
||
3. （可选）关键词：名称、账号、邮箱、地址等。
|
||
4. 若类型为交易所 API，可再选 Binance / OKX / Gate。
|
||
5. 点击 **「确认」** 显示列表。
|
||
|
||
| 操作 | 说明 |
|
||
|------|------|
|
||
| **隐藏敏感字段** | 勾选后以圆点显示；复制仍为明文 |
|
||
| **复制** | 字段右侧「复制」 |
|
||
| **图片** | 助记词/密钥等记录可预览已上传图片；**点击图片可放大**，按 Esc 或点遮罩关闭 |
|
||
| **删除** | 卡片右上角，需确认 |
|
||
|
||
---
|
||
|
||
## 6. 系统设置
|
||
|
||
右上角进入，内含三个 Tab：
|
||
|
||
### 6.1 账户密码
|
||
|
||
修改登录用户名/密码（写入 `.env`），需填写当前密码确认。
|
||
|
||
### 6.2 自定义类型
|
||
|
||
新增类型时字段类型可选：文本 / 敏感 / 多行 / 链接 / 邮箱 / 手机 / **图片**。
|
||
|
||
删除自定义类型会同时删除该类型下所有凭证。
|
||
|
||
### 6.3 备份恢复
|
||
|
||
| 操作 | 说明 |
|
||
|------|------|
|
||
| **下载备份** | 浏览器下载 `.tar.gz`（含 .env、data.json、settings.json、uploads） |
|
||
| **立即备份到服务器** | 写入 `/root/crypto_key_backups/`（无权限时为项目 `backups/`） |
|
||
| **选择备份文件恢复** | 上传 `.tar.gz` 覆盖当前数据 |
|
||
|
||
服务器每日 **03:00** 自动备份（应用内线程 + 部署时安装的 cron）。
|
||
|
||
> 恢复后 `.env` 中的 `DATA_ENCRYPTION_KEY` 必须与备份一致，否则无法解密。
|
||
|
||
---
|
||
|
||
## 7. 安全与使用建议
|
||
|
||
1. **仅在可信局域网使用**，不要将 5200 端口映射到公网。
|
||
2. 使用「备份恢复」或定期检查 `/root/crypto_key_backups/`。
|
||
3. **不要** 将 `.env`、`data.json`、`uploads/` 提交到 Git。
|
||
4. 助记词/私钥属于高敏感信息，复制后尽快清除剪贴板。
|
||
|
||
---
|
||
|
||
## 8. 常见问题
|
||
|
||
**Q：登录提示用户名或密码错误？**
|
||
A：检查 `.env` 中 `AUTH_*`；或默认 `admin` / `admin123` 后在设置中修改。
|
||
|
||
**Q：添加成功但查询不到？**
|
||
A：确认查询类型与添加时一致；可先选「全部类型」再搜关键词。
|
||
|
||
**Q：图片上传失败？**
|
||
A：仅支持 jpg/png/gif/webp/bmp，单文件不超过约 16MB。
|
||
|
||
**Q：恢复备份后打不开数据？**
|
||
A：确认备份包内 `.env` 的 `DATA_ENCRYPTION_KEY` 完整。
|
||
|
||
**Q：更新代码怎么做？**
|
||
A：服务器执行：
|
||
|
||
```bash
|
||
curl -fsSL https://git.bz121.com/dekun/crypto_key/raw/branch/main/deploy/manage.sh | bash
|
||
```
|
||
|
||
选择 **2 更新**（仅 git pull，不要用 scp）。
|
||
|
||
---
|
||
|
||
## 9. 相关文档
|
||
|
||
| 文档 | 内容 |
|
||
|------|------|
|
||
| [README.md](./README.md) | 项目概览 |
|
||
| [DEPLOY.md](./DEPLOY.md) | 安装与运维 |
|
||
| [CHANGELOG.md](./CHANGELOG.md) | 版本更新记录 |
|