wangairnan/pure-note
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 2 Wiki Activity

文档与 usage：--data-dir 默认 ./data，示例去除冗余参数

Browse Source
This commit is contained in:
wangairnan
2026-09-08 16:13:36 +08:00
parent 2d02756fa3
commit 6bfe20ee00
3 changed files with 14 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+6 -6
View File
@@ -20,11 +20,11 @@
make build make build
# 2. 初始化（设置管理员口令与站点标题） # 2. 初始化（设置管理员口令与站点标题）
./pure-note init --data-dir ./data ./pure-note init
# 非交互：PN_ADMIN_PASSWORD=xxx PN_SITE_TITLE=yyy ./pure-note init --data-dir ./data # 非交互：PN_ADMIN_PASSWORD=xxx PN_SITE_TITLE=yyy ./pure-note init
# 3. 启动 # 3. 启动
./pure-note serve --addr 127.0.0.1:8080 --data-dir ./data ./pure-note serve --addr 127.0.0.1:8080
# 4. 访问 # 4. 访问
# 博客： http://127.0.0.1:8080/ # 博客： http://127.0.0.1:8080/
@@ -34,7 +34,7 @@ make build
开发模式（本机调试，Cookie 允许非 Secure，仅限 loopback 监听）： 开发模式（本机调试，Cookie 允许非 Secure，仅限 loopback 监听）：
```bash ```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 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 可达即具备服务器权限，可直接重设；重设后全部会话被吊销）： 忘记口令（CLI 可达即具备服务器权限，可直接重设；重设后全部会话被吊销）：
```bash ```bash
./pure-note reset-password --data-dir ./data ./pure-note reset-password
# 非交互：PN_ADMIN_PASSWORD=xxx ./pure-note reset-password --data-dir ./data # 非交互：PN_ADMIN_PASSWORD=xxx ./pure-note reset-password
``` ```
## 测试 ## 测试
cmd/pure-note/main.go
+7 -5
View File
@@ -67,12 +67,14 @@ func usage() {
fmt.Print(`pure-note — 极简高安全私人笔记 + 博客 fmt.Print(`pure-note — 极简高安全私人笔记 + 博客
用法: 用法:
pure-note serve [--addr :8080] [--data-dir ./data] [--behind-proxy] [--dev] [--allow-newer] pure-note serve [--addr :8080] [--behind-proxy] [--dev] [--allow-newer]
pure-note init [--data-dir ./data] pure-note init
pure-note reset-password [--data-dir ./data] # 重设管理员口令并吊销全部会话 pure-note reset-password # 重设管理员口令并吊销全部会话
pure-note backup [--data-dir ./data] [输出路径] pure-note backup [输出路径]
pure-note gc [--data-dir ./data] [--commit] # 默认 dry-run pure-note gc [--commit] # 默认 dry-run
pure-note version pure-note version
# --data-dir 可指定数据目录，默认 ./data
`) `)
} }
docs/design.md
+1 -1
View File
@@ -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 init` | 首次初始化：设口令（Argon2id+PHC）、站点标题 |
| `pure-note reset-password` | 重设管理员口令（覆盖旧哈希）并吊销全部会话；口令来源同 `init`（环境变量 `PN_ADMIN_PASSWORD` 或交互输入，不经 argv 避免 ps 泄露）。CLI 可达即具备服务器权限，允许直接重设 | | `pure-note reset-password` | 重设管理员口令（覆盖旧哈希）并吊销全部会话；口令来源同 `init`（环境变量 `PN_ADMIN_PASSWORD` 或交互输入，不经 argv 避免 ps 泄露）。CLI 可达即具备服务器权限，允许直接重设 |
| `pure-note backup [path]` | 在线备份：`VACUUM INTO`（一致快照，不停服）；默认输出 0600 权限 | | `pure-note backup [path]` | 在线备份：`VACUUM INTO`（一致快照，不停服）；默认输出 0600 权限 |