dsh-plugin-repo-snapshot

使用

重启后打开 设置 → 仓库快照备份。

1. 启用 开关决定是否创建快照
2. 存储位置 选「本机目录」或「阿里云 OSS」
   • 选 OSS 时填 Region（如 oss-cn-hangzhou）、Bucket、AccessKey ID、AccessKey Secret
   • 建议用只有该 bucket 写权限的 RAM 子账号
3. 点 保存并测试连接 验证配置（会在目标位置写入并删除一个探针文件）
4. 点 立即备份一次 立即生成一份快照；也可等会话开始自动触发

阿里云 OSS 建议

• 权限策略最小化：只给目标 bucket 的 PutObject / DeleteObject

• 想让密钥不落盘？把设置页的 AK/SK 留空，改用环境变量：

  export ALIYUN_OSS_ACCESS_KEY_ID=LTAI...
  export ALIYUN_OSS_ACCESS_KEY_SECRET=...
  

---

配置参考

设置页写入 /repo-snapshot/settings.json，优先于 cordis.patch.yml 里的配置。

配置项	默认	说明
enabled	true	总开关
oss.provider	local	local / aliyun
oss.region	—	如 oss-cn-hangzhou
oss.bucket	—	bucket 名
oss.prefix	repo-snapshots/	对象键前缀
oss.signatureVersion	auto	OSS 签名方案：auto（先试 V4，失败回退 V1）/ v4 / v1
oss.localDir	``	本机模式根目录；前缀会追加在其后
encryption.enabled	true	是否加密
encryption.algorithm	aes-256-gcm	aes-256-gcm / aes-256-ctr
scan.includeGit	true	是否包含 .git
scan.excludePatterns	node_modules, dist, .venv, …	裸目录名匹配任意层级
scan.maxFileSizeMB	5	单文件上限，超限跳过并计数
scan.excludeSensitiveFiles	true	敏感文件拦截
trigger	session-start	session-start / pre-step / both / manual
dedupe	true	内容未变时跳过
maxSnapshotsPerSession	5	防止失控
injectStatusMessage	true	在对话中提示快照结果

HTTP 接口

宿主注册了四个路由，供设置页调用（也可脚本化）：

方法	路径	说明
GET	/plugins/repo-snapshot/status	当前配置（密钥已脱敏）、密钥指纹、最近快照
POST	/plugins/repo-snapshot/settings	保存设置，接受扁平字段名或点号路径
POST	/plugins/repo-snapshot/test	探测目的地是否可用
POST	/plugins/repo-snapshot/backup-now	立即备份，可传 workspacePath

---