dekun/crypto_key

Fork 0

Files

T

dekun 703fd912f8 更新md

2026-05-27 07:45:16 +08:00

6.4 KiB

Raw Permalink Blame History

使用说明 — crypto_key 凭证保险库

本文档介绍日常使用方法。部署与安装请参阅 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. 首次登录

启动服务后，在浏览器打开上述地址。
输入 用户名 和密码。
首次部署时，若未配置 .env，系统可能自动生成默认账号：
- 用户名：admin
- 密码：admin123
登录后请立即进入「系统设置」修改用户名和密码。

登录状态保存在服务端 Session（HttpOnly Cookie），关闭浏览器后需重新登录（约 30 分钟无操作也会失效）。

3. 界面总览

登录成功后主界面包含三块：

区域	作用
添加凭证	选择类型、填写字段、保存
查询凭证	按类型/关键词筛选，点击「确认」后展示列表
凭证列表	展示查询结果；支持打码显示与复制

右上角：

系统设置：修改登录账号、管理自定义类型
退出：清除登录状态

4. 添加凭证

4.1 选择类型

在「添加凭证」区域的 凭证类型 输入框中输入关键字（如「交易所」「邮箱」「小红书」）。
从下拉列表中点击需要的类型。
下方会显示「已选：xxx」，并出现对应表单。

4.2 各类型必填说明

类型	主要字段
交易所 API	交易所、账户名称、API Key、API Secret；OKX 额外必填 Passphrase 密码
网站账号	名称、网址、用户名、密码
邮箱账户	名称、邮箱地址、密码；可选网页登录地址
企业微信机器人	名称、Webhook
钉钉机器人	名称、Webhook
微信	名称、微信号、手机号
QQ	名称、QQ 号、手机号
自定义类型	按你在系统设置中定义的字段填写

4.3 提交

填写完成后点击 「添加」。
添加成功后会提示：不会自动显示在列表中。
需要到「查询凭证」区域选择类型并点击 「确认」 才能查看。

5. 查询凭证

5.1 基本查询

在「查询凭证」中选择或搜索类型（下拉框支持输入过滤）。
（可选）在 关键词 中输入名称、账号、邮箱等片段。
若类型为 交易所 API，可再选 Binance / OKX / Gate。
点击右侧 「确认」。
列表显示该条件下所有记录。

5.2 列表操作

操作	说明
隐藏敏感字段	勾选后界面以圆点显示密码、Key 等；复制按钮仍为真实明文
复制	每条字段右侧「复制」按钮
链接	网站「网址」、邮箱「邮箱地址」、邮箱「网页登录地址」可点击跳转
删除	卡片右上角「删除」，需确认

5.3 未查询时

默认显示：「选择类型并点击「确认」查看」——不会展示任何凭证内容。

6. 系统设置

点击右上角 「系统设置」 进入。

6.1 修改登录账号（写入 .env）

填写 新用户名、新密码（至少 6 位）。
填写 当前密码 以确认身份。
点击 「保存登录设置」。
修改后请使用新账号重新登录。

登录凭据保存在服务器 .env 文件中，不会出现在浏览器缓存。

6.2 自定义凭证类型

适用于小红书、抖音、快手等未内置的类型。

新增类型：

类型 ID：英文小写+下划线，如 xiaohongshu（创建后不可改）。
显示名称：如 小红书。
字段列表：点击「+ 添加字段」
- key：英文标识，如 account
- 显示名：如 账号
- 类型：文本 / 敏感 / 链接 / 邮箱 / 手机
- 必填：是否必填
点击 「保存自定义类型」。

搜索 / 删除：

顶部搜索框可过滤已有自定义类型。
「删除」会同时删除该类型下的 所有凭证记录。

7. 安全与使用建议

仅在可信局域网使用，不要将 5200 端口映射到公网。
定期备份 data.json 和 .env（见 DEPLOY.md 备份章节）。
不要将 .env、data.json 提交到 Git 或发给他人。
若更换服务器，需同时拷贝 .env 与 data.json，否则无法解密数据。
复制敏感内容后，尽快粘贴使用，避免长时间留在系统剪贴板。

8. 常见问题

Q：登录提示用户名或密码错误？
A：检查 .env 中 AUTH_USERNAME / AUTH_PASSWORD；或使用部署时的默认 admin / admin123 后在设置中修改。

Q：添加成功但查询不到？
A：确认查询的类型与添加时一致；交易所需选对 Binance/OKX/Gate。

Q：局域网手机打不开？
A：确认手机与服务器同一 WiFi；防火墙放行 5200；使用 http://服务器IP:5200 而非 127.0.0.1。

Q：复制按钮无效？
A：使用 http:// 访问（非 file://）；浏览器需允许剪贴板权限。

Q：更新代码后无法登录或数据打不开？
A：执行 pip install -r requirements.txt 并重启 PM2；确认 .env 中 DATA_ENCRYPTION_KEY 未变。

Q：旧版明文 data.json 还能用吗？
A：可以。服务启动后首次读取会自动迁移为加密格式，建议迁移前备份原文件。

9. 相关文档

文档	内容
README.md	项目概览
DEPLOY.md	安装与运维
CHANGELOG.md	版本更新记录

6.4 KiB Raw Permalink Blame History Unescape Escape