From 6bfe20ee003568b4cac56a4cdd5da695293c775b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E7=A0=81=E5=86=9C=E9=98=BF=E6=A5=A0?= Date: Tue, 8 Sep 2026 16:13:36 +0800 Subject: [PATCH] =?UTF-8?q?=E6=96=87=E6=A1=A3=E4=B8=8E=20usage=EF=BC=9A--d?= =?UTF-8?q?ata-dir=20=E9=BB=98=E8=AE=A4=20./data=EF=BC=8C=E7=A4=BA?= =?UTF-8?q?=E4=BE=8B=E5=8E=BB=E9=99=A4=E5=86=97=E4=BD=99=E5=8F=82=E6=95=B0?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 12 ++++++------ cmd/pure-note/main.go | 12 +++++++----- docs/design.md | 2 +- 3 files changed, 14 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index fb87de5..58a40e5 100644 --- a/README.md +++ b/README.md @@ -20,11 +20,11 @@ make build # 2. 初始化（设置管理员口令与站点标题） -./pure-note init --data-dir ./data -# 非交互：PN_ADMIN_PASSWORD=xxx PN_SITE_TITLE=yyy ./pure-note init --data-dir ./data +./pure-note init +# 非交互：PN_ADMIN_PASSWORD=xxx PN_SITE_TITLE=yyy ./pure-note init # 3. 启动 -./pure-note serve --addr 127.0.0.1:8080 --data-dir ./data +./pure-note serve --addr 127.0.0.1:8080 # 4. 访问 # 博客： http://127.0.0.1:8080/ @@ -34,7 +34,7 @@ make build 开发模式（本机调试，Cookie 允许非 Secure，仅限 loopback 监听）： ```bash -./pure-note serve --dev --addr 127.0.0.1:8080 --data-dir ./data +./pure-note serve --dev --addr 127.0.0.1:8080 # 前端热重载（另开终端）： cd web && npm install && npm run dev # /api 代理到 127.0.0.1:8080 ``` @@ -42,8 +42,8 @@ cd web && npm install && npm run dev # /api 代理到 127.0.0.1:8080 忘记口令（CLI 可达即具备服务器权限，可直接重设；重设后全部会话被吊销）： ```bash -./pure-note reset-password --data-dir ./data -# 非交互：PN_ADMIN_PASSWORD=xxx ./pure-note reset-password --data-dir ./data +./pure-note reset-password +# 非交互：PN_ADMIN_PASSWORD=xxx ./pure-note reset-password ``` ## 测试 diff --git a/cmd/pure-note/main.go b/cmd/pure-note/main.go index 243e000..56e5588 100644 --- a/cmd/pure-note/main.go +++ b/cmd/pure-note/main.go @@ -67,12 +67,14 @@ func usage() { fmt.Print(`pure-note — 极简高安全私人笔记 + 博客 用法: - pure-note serve [--addr :8080] [--data-dir ./data] [--behind-proxy] [--dev] [--allow-newer] - pure-note init [--data-dir ./data] - pure-note reset-password [--data-dir ./data] # 重设管理员口令并吊销全部会话 - pure-note backup [--data-dir ./data] [输出路径] - pure-note gc [--data-dir ./data] [--commit] # 默认 dry-run + pure-note serve [--addr :8080] [--behind-proxy] [--dev] [--allow-newer] + pure-note init + pure-note reset-password # 重设管理员口令并吊销全部会话 + pure-note backup [输出路径] + pure-note gc [--commit] # 默认 dry-run pure-note version + + # --data-dir 可指定数据目录，默认 ./data `) } diff --git a/docs/design.md b/docs/design.md index 22ce54a..973cafb 100644 --- a/docs/design.md +++ b/docs/design.md @@ -376,7 +376,7 @@ SecurityHeaders（含 HSTS，§9.2） | 子命令 / 开关 | 说明 | | --- | --- | -| `pure-note serve` | 启动；`--addr :8080`、`--data-dir ./data`、`--log-level`、`--log-format text|json`、`--behind-proxy`（声明位于可信反代之后，启用 XFF 处理）、`--dev`（loopback-only，§7.3-8）、`--allow-newer`（跳过 schema 版本上界校验，§10.4）；环境变量：`PN_ADMIN_PASSWORD` | +| `pure-note serve` | 启动；`--addr :8080`、`--data-dir`（默认 `./data`）、`--log-level`、`--log-format text|json`、`--behind-proxy`（声明位于可信反代之后，启用 XFF 处理）、`--dev`（loopback-only，§7.3-8）、`--allow-newer`（跳过 schema 版本上界校验，§10.4）；环境变量：`PN_ADMIN_PASSWORD` | | `pure-note init` | 首次初始化：设口令（Argon2id+PHC）、站点标题 | | `pure-note reset-password` | 重设管理员口令（覆盖旧哈希）并吊销全部会话；口令来源同 `init`（环境变量 `PN_ADMIN_PASSWORD` 或交互输入，不经 argv 避免 ps 泄露）。CLI 可达即具备服务器权限，允许直接重设 | | `pure-note backup [path]` | 在线备份：`VACUUM INTO`（一致快照，不停服）；默认输出 0600 权限 |