v2.0.0: 多目标备份 + S3云存储 + 完整性校验 + 9语言国际化

feat: v2.0.0 — 多目标备份 + S3云存储 + 审计日志 + 9语言国际化
This commit is contained in:
xiatianxuan authored and GitHub committed 2026-06-20 14:01:43 +08:00
1 parent c8c704a9c6
commit 8f2bcdf8fa
89 files changed
+37677 -1387

No files matched your search

+665
View File
@@ -0,0 +1,665 @@
# Sbackup
[![Python](https://img.shields.io/badge/Python-3.10+-3776AB?logo=python&logoColor=white)](https://www.python.org/)
[![License](https://img.shields.io/badge/License-GPL--3.0-green)](LICENSE)
[![PyPI](https://img.shields.io/pypi/v/sbackup-cli?color=blue)](https://pypi.org/project/sbackup-cli/)
[![Tests](https://img.shields.io/badge/tests-940%20passed-brightgreen)](.github/workflows/ci.yml)
[![Platform](https://img.shields.io/badge/platform-Windows%20%7C%20macOS%20%7C%20Linux-lightgrey)]()
> 轻量、高效的文件夹备份工具,支持命令行操作,帮助你轻松管理备份策略。
[English](../../README.md) | [Deutsch](README_de.md) | [Espanol](README_es.md) | [Francais](README_fr.md) | [Italiano](README_it.md) | [Portugues](README_pt.md) | [Pycckuu](README_ru.md) | [日本語](README_ja.md) | [한국어](README_ko.md)
- [简介](#简介)
- [功能特性](#功能特性)
- [快速开始](#快速开始)
- [安装](#安装)
- [使用方法](#使用方法)
- [配置文件](#配置文件)
- [配置示例](#配置示例)
- [SFTP 远程备份](#sftp-远程备份)
- [WebDAV 远程备份](#webdav-远程备份)
- [实现原理](#实现原理)
- [开发指南](#开发指南)
- [运行测试](#运行测试)
- [代码结构](#代码结构)
- [常见问题](#常见问题)
- [贡献指南](#贡献指南)
- [许可证](#许可证)
- [作者](#作者)
---
## 简介
Sbackup 是一个轻量级的文件夹备份工具,支持通过命令行添加、删除和查看备份策略。它基于文件夹的最后修改时间来决定是否需要进行备份,确保你的数据始终保持最新状态。
## 功能特性
- ✅ **增量备份**:仅备份已更改的文件夹,节省时间和存储空间
- ✅ **多格式支持**:支持 ZIP、tar、tar.gz、tar.bz2、tar.xz、tar.zst、7z 七种打包格式,全局和条目级均可独立指定
- ✅ **SFTP 远程备份**:基于 paramiko 库,支持密码/SSH 私钥认证、自动检测默认私钥
- ✅ **WebDAV 远程备份**:基于标准库 urllib,零额外依赖,支持坚果云/NextCloud/群晖
- ✅ **S3 云存储**:基于 minio 库,支持所有 S3 兼容存储(AWS/MinIO/阿里云 OSS 等)
- ✅ **多目标并行备份**:同时备份到本地 + 多个远程目标,互不影响
- ✅ **备份还原**:支持从备份文件解压还原到指定目录,支持选择性恢复
- ✅ **备份清理**:自动删除旧备份,支持按数量/时间/每日保留策略
- ✅ **加密备份**:支持 7z 格式密码加密 + 全格式 PBKDF2 加密
- ✅ **定时备份**:设置间隔自动执行,支持实时文件监控(watchdog)
- ✅ **备份历史**:记录每次备份的时间、大小、SHA256 校验和,方便追溯
- ✅ **审计日志**:记录所有备份/恢复操作的审计事件
- ✅ **Pre/Post Hook**:备份前后执行自定义命令
- ✅ **配置 Profile**:支持多配置方案的保存、切换、导入导出
- ✅ **跨档案搜索**:在多个备份文件中搜索匹配的文件名
- ✅ **数据完整性**:SHA256 校验和生成与验证,Reed-Solomon 纠错码
- ✅ **配置校验**:自动校验配置参数合法性,检测篡改
- ✅ **任务队列**:管理备份任务队列,支持添加、执行、取消
- ✅ **压缩基准测试**:比较不同格式/级别的压缩性能
- ✅ **磁盘空间预估**:按文件类型估算备份大小,检查目标空间
- ✅ **国际化**:支持中文、英语、法语、西班牙语、俄语、德语、日语、葡萄牙语、韩语九种语言
- ✅ **Shell 补全**:支持 bash/zsh/fish/powershell 自动补全
- ✅ **轻量高效**:体积小,启动速度快,资源占用低
- ✅ **跨平台支持**:支持 Windows、macOS 和 Linux
## 快速开始
### 安装
#### 使用 pip 安装
```bash
pip install sbackup-cli
```
安装后使用 `sbackup` 命令(PyPI 包名为 `sbackup-cli`,CLI 命令为 `sbackup`)。
#### 从源码安装
```bash
git clone https://github.com/xiatianxuan/sbackup.git
cd sbackup
uv sync
```
### 使用方法
#### 基本语法
```bash
uv run python main.py <command> [options]
```
#### 可用命令
| 命令 | 描述 |
|------|------|
| `add` | 添加备份策略 |
| `rm` / `remove` | 删除备份策略 |
| `edit` | 编辑已有备份策略 |
| `all` | 查看所有备份策略 |
| `save` | 执行备份 |
| `watch` | 定时执行备份 |
| `restore` | 从备份文件还原 |
| `info` | 查看备份文件详情 |
| `diff` | 对比源目录与备份的差异 |
| `verify` | 校验备份文件完整性 |
| `search` | 在备份中搜索文件 |
| `xsearch` | 跨多个备份档案搜索 |
| `versions` | 查看备份版本历史 |
| `sftp` | SFTP 远程备份管理 |
| `webdav` | WebDAV 远程备份管理 |
| `remote` | 远程文件管理(list/rm) |
| `task` | 备份任务队列管理 |
| `audit` | 审计日志查询 |
| `hooks` | 手动执行 Pre/Post Hook |
| `profile` | 配置 Profile 管理 |
| `rotate` | 备份轮转清理 |
| `clean` | 清理旧备份 |
| `diskcheck` | 磁盘空间预估 |
| `benchmark` | 压缩格式基准测试 |
| `integrity` | 备份目录完整性校验 |
| `dry-run` | 预览备份文件选择 |
| `export` / `import` | 导出/导入备份策略 |
| `ignore` | 生成 .sbackupignore 文件 |
| `schedule` | 导出定时调度配置 |
| `webhook` | 配置 Webhook 预设 |
| `config` | 配置加密/校验 |
| `report` | 生成备份报告 |
| `completion` | 生成 Shell 补全脚本 |
| `wizard` | 交互式配置向导 |
| `status` | 备份状态仪表盘 |
| `version` | 查看版本信息 |
| `help` | 查看帮助信息 |
#### 全局参数
| 参数 | 描述 |
|------|------|
| `--lang zh_CN` / `en_US` / `fr_FR` / `es_ES` / `ru_RU` / `de_DE` / `ja_JP` / `pt_BR` / `ko_KR` | 设置界面语言(持久化到 config.json) |
| `--format zip` / `tar` / `tar.gz` / `tar.bz2` / `tar.xz` / `tar.zst` / `7z` | 设置打包格式(持久化到 config.json) |
| `--debug` | 开启调试日志 |
#### 添加备份策略
```bash
uv run python main.py add <source> <dest> [-i ignore_patterns]
```
参数说明:
- **source**:需要备份的源文件夹路径
- **dest**:备份文件存放的目标路径
- **-i, --ignore**:需要忽略的文件或文件夹名称,使用逗号分隔(默认:`.git,__pycache__`)
- **--format**:条目级打包格式(仅作用于该备份策略,不指定则使用全局默认):`zip` / `tar` / `tar.gz` / `tar.bz2` / `tar.xz` / `tar.zst` / `7z`
示例:
```bash
# 使用全局默认格式添加策略
uv run python main.py add F:/my_folder F:/backup -i node_modules,.git
# 为该策略指定 tar.gz 格式(每次备份此文件夹都使用 tar.gz)
uv run python main.py add F:/my_folder F:/backup --format tar.gz
# 指定 7z 格式(仅此文件夹)
uv run python main.py add F:/my_folder F:/backup --format 7z
```
#### 删除备份策略
```bash
uv run python main.py rm <path>
```
参数说明:
- **path**:需要删除备份策略的源文件夹路径
示例:
```bash
uv run python main.py rm F:/my_folder
```
#### 查看所有备份策略
```bash
uv run python main.py all
```
显示当前所有已配置的备份策略。
#### 执行备份
```bash
# 使用默认格式(ZIP)
uv run python main.py save
# 使用 tar.gz 格式
uv run python main.py --format tar.gz save
# 保留最近 5 个备份文件,自动清理旧的
uv run python main.py save --keep 5
# 使用 7z 格式并加密
uv run python main.py --format 7z save --password mysecret
# 英文界面 + tar.xz 格式
uv run python main.py --lang en_US --format tar.xz save
```
**save 命令参数:**
| 参数 | 默认值 | 描述 |
|------|--------|------|
| `--keep N` | `0` | 保留最近 N 个备份文件,0 表示不清理 |
| `--password PASSWORD` | `""` | 加密密码(仅 7z 格式支持) |
| `--sftp` | `false` | 备份完成后上传到 SFTP 服务器 |
| `--webdav` | `false` | 备份完成后上传到 WebDAV 服务器 |
根据备份策略,自动备份已更改的文件夹。
#### 定时备份
```bash
# 每 60 分钟执行一次备份
uv run python main.py watch --interval 60
# 每 2 小时备份一次,保留最近 10 个文件
uv run python main.py watch --interval 120 --keep 10
# 定时备份 + 7z 加密
uv run python main.py --format 7z watch --interval 60 --password mysecret
```
**watch 命令参数:**
| 参数 | 默认值 | 描述 |
|------|--------|------|
| `--interval MINUTES` | `60` | 备份间隔(分钟) |
| `--keep N` | `0` | 保留最近 N 个备份文件 |
| `--password PASSWORD` | `""` | 加密密码(仅 7z 格式支持) |
| `--sftp` | `false` | 每次备份后上传到 SFTP 服务器 |
| `--webdav` | `false` | 每次备份后上传到 WebDAV 服务器 |
按 `Ctrl+C` 停止定时备份。
#### 还原备份
```bash
uv run python main.py restore <backup_file> <target_dir>
```
参数说明:
- **backup_file**:备份文件路径(支持 .zip / .tar / .tar.gz / .tar.bz2 / .tar.xz / .tar.zst / .7z)
- **target_dir**:还原目标目录
示例:
```bash
uv run python main.py restore F:/backup/my_folder.tar.gz F:/restored
uv run python main.py restore F:/backup/my_folder.7z F:/restored
uv run python main.py restore F:/backup/my_folder.tar.zst F:/restored
```
#### SFTP 远程备份
```bash
# ============ 快速开始(推荐) ============
# 1. 配置 SFTP(自动检测 SSH 私钥,无需手动指定)
sbackup sftp config --host 192.168.1.100 --user admin --remote-path /backups
# 2. 测试连接
sbackup sftp test
# 3. 执行备份并上传
sbackup save --sftp
# ============ 认证方式 ============
# 方式一:自动检测私钥(推荐)
# 系统自动尝试 ~/.ssh/id_ed25519 → id_rsa → id_ecdsa
sbackup sftp config --host 192.168.1.100 --user admin
# 方式二:密码认证
sbackup sftp config --host 192.168.1.100 --user admin --password secret
# 方式三:指定私钥
sbackup sftp config --host 192.168.1.100 --user admin --key-file ~/.ssh/id_rsa
# 方式四:私钥 + 密码短语(交互式输入)
sbackup sftp config --host 192.168.1.100 --user admin --key-file ~/.ssh/id_rsa
# 方式五:私钥 + 密码短语(命令行指定)
sbackup sftp config --host 192.168.1.100 --user admin --key-file ~/.ssh/id_rsa --key-passphrase mykeypass
# ============ 使用场景 ============
# 场景一:一次性备份并上传
sbackup save --sftp
# 场景二:定时备份并自动上传(每 60 分钟)
sbackup watch --interval 60 --sftp
# 场景三:指定格式备份 + 上传
sbackup --format tar.gz save --sftp
# 场景四:加密备份 + 上传
sbackup --format 7z save --password mysecret --sftp
# 场景五:保留最近 5 个备份 + 上传
sbackup save --keep 5 --sftp
# ============ 高级用法 ============
# 交互式配置(逐步输入所有参数)
sbackup sftp config
# 非交互式配置(全部参数在命令行指定)
sbackup sftp config --host 192.168.1.100 --port 22 --user admin --password secret --remote-path /backups
# 测试连接并查看详细日志
sbackup --debug sftp test
```
**sftp 子命令:**
| 子命令 | 描述 | 示例 |
|--------|------|------|
| `sftp config` | 配置 SFTP 连接参数(host/port/user/password/key_file/key_passphrase/remote_path) | `sbackup sftp config --host 192.168.1.100 --user admin` |
| `sftp test` | 测试 SFTP 连接是否可用 | `sbackup sftp test` |
**认证方式:**
| 方式 | 参数 | 说明 | 示例 |
|------|------|------|------|
| **自动检测** | 不指定认证参数 | 自动尝试 `~/.ssh/id_ed25519` → `id_rsa` → `id_ecdsa`(推荐) | `sbackup sftp config --host ... --user ...` |
| 密码认证 | `--password` | 直接使用密码登录 | `sbackup sftp config --host ... --user ... --password secret` |
| 私钥认证 | `--key-file` | 使用指定 SSH 私钥登录 | `sbackup sftp config --host ... --user ... --key-file ~/.ssh/id_rsa` |
| 私钥+短语 | `--key-file` + `--key-passphrase` | 私钥有密码短语时使用 | `sbackup sftp config --host ... --user ... --key-file ~/.ssh/id_rsa --key-passphrase mypass` |
支持的私钥格式:RSA、Ed25519、ECDSA。
**跨平台路径支持:**
| 平台 | 私钥路径示例 | 说明 |
|------|-------------|------|
| Linux/mac | `~/.ssh/id_rsa` | 自动展开为 `/home/user/.ssh/id_rsa` |
| Windows | `~/.ssh/id_rsa` | 自动展开为 `C:\Users\username\.ssh\id_rsa` |
| 全平台 | 绝对路径 | 直接使用完整路径 |
SFTP 配置保存在 `config.json` 的 `sftp` 字段中,支持命令行参数或交互式输入。
#### 查看版本信息
```bash
sbackup version
```
## 配置文件
Sbackup 支持通过 `config.json` 文件进行自定义配置。配置文件应放在项目根目录下。
### 配置项说明
```json
{
"compression_format": "ZIP",
"compression": {
"algorithm": "ZIP_DEFLATED",
"level": 6
},
"skip_patterns": [".git", "__pycache__"],
"data_file": "sbackup.json",
"lang": "zh_CN",
"password": "",
"sftp": {
"host": "",
"port": 22,
"user": "",
"password": "",
"key_file": "",
"key_passphrase": "",
"remote_path": "/",
"enabled": false
}
}
```
| 配置项 | 类型 | 默认值 | 描述 |
|--------|------|--------|------|
| `compression_format` | string | `"ZIP"` | 打包格式,可选值:`ZIP`, `TAR`, `TAR_GZ`, `TAR_BZ2`, `TAR_XZ`, `TAR_ZST`, `7Z` |
| `compression.algorithm` | string | `"ZIP_DEFLATED"` | ZIP 压缩算法,可选值:`ZIP_DEFLATED`, `ZIP_STORED`, `ZIP_BZIP2`, `ZIP_LZMA` |
| `compression.level` | int | `6` | 压缩级别,范围 0-9(0 为不压缩,9 为最高压缩) |
| `skip_patterns` | list | `[".git", "__pycache__"]` | 需要忽略的文件或文件夹模式(支持 fnmatch 通配符和路径匹配) |
| `data_file` | string | 平台默认路径 | 备份策略数据文件的存放路径 |
| `lang` | string | `"zh_CN"` | 界面语言,可选值:`zh_CN`, `en_US`, `fr_FR`, `es_ES`, `ru_RU`, `de_DE`, `ja_JP`, `pt_BR`, `ko_KR` |
| `password` | string | `""` | 7z 加密密码 |
| `sftp.host` | string | `""` | SFTP 服务器地址 |
| `sftp.port` | int | `22` | SFTP 端口 |
| `sftp.user` | string | `""` | SFTP 用户名 |
| `sftp.password` | string | `""` | SFTP 密码(密码认证时使用) |
| `sftp.key_file` | string | `""` | SSH 私钥文件路径(私钥认证时使用,推荐) |
| `sftp.key_passphrase` | string | `""` | 私钥密码短语(如有) |
| `sftp.remote_path` | string | `"/"` | 远程目标路径 |
| `sftp.enabled` | bool | `false` | 是否启用 SFTP |
### 示例配置
使用 tar.bz2 格式进行高压缩率备份:
```json
{
"compression_format": "TAR_BZ2",
"compression_level": 9,
"skip_patterns": [".git", "__pycache__", "node_modules", "*.log"],
"data_file": "backup_strategies.json",
"lang": "zh_CN"
}
```
### 打包格式对比
| 格式 | 扩展名 | 压缩率 | 速度 | 依赖 | 适用场景 |
|------|--------|--------|------|------|----------|
| ZIP | .zip | 中 | 快 | 标准库 | 通用,Windows 兼容性最好 |
| tar | .tar | 无 | 极快 | 标准库 | 纯归档,配合外部压缩 |
| tar.gz | .tar.gz | 中 | 快 | 标准库 | Linux/macOS 通用 |
| tar.bz2 | .tar.bz2 | 高 | 中 | 标准库 | 高压缩率归档 |
| tar.xz | .tar.xz | 最高 | 慢 | 标准库 | 长期归档,空间敏感 |
| tar.zst | .tar.zst | 中高 | 极快 | zstandard | 现代场景,速度与压缩率平衡 |
| 7z | .7z | 极高 | 慢 | py7zr | 最高压缩率,支持加密 |
#### WebDAV 远程备份
WebDAV 是基于 HTTP 的文件协议,支持坚果云、NextCloud、群晖等主流网盘。使用 Python 标准库 `urllib`,**零额外依赖**。
```bash
# ============ 快速开始 ============
# 1. 配置 WebDAV
sbackup webdav config --url https://dav.jianguoyun.com/dav/ --user user@example.com --password secret
# 2. 测试连接
sbackup webdav test
# 3. 执行备份并上传
sbackup save --webdav
# ============ 使用场景 ============
# 场景一:一次性备份并上传
sbackup save --webdav
# 场景二:定时备份并自动上传(每 60 分钟)
sbackup watch --interval 60 --webdav
# 场景三:指定远程子目录
sbackup webdav config --url https://dav.jianguoyun.com/dav/ --user user@example.com --remote-path /backups/sbackup
# 场景四:同时上传到 SFTP 和 WebDAV
sbackup save --sftp --webdav
# ============ 常见 WebDAV 服务地址 ============
# 坚果云: https://dav.jianguoyun.com/dav/
# NextCloud: https://your-server/remote.php/dav/files/username/
# 群晖: https://your-synology:5006/webdav/
```
**webdav 子命令:**
| 子命令 | 描述 | 示例 |
|--------|------|------|
| `webdav config` | 配置 WebDAV 连接参数(url/user/password/remote_path) | `sbackup webdav config --url ... --user ...` |
| `webdav test` | 测试 WebDAV 连接是否可用 | `sbackup webdav test` |
| 参数 | 默认值 | 描述 |
|------|--------|------|
| `--url URL` | `""` | WebDAV 服务器地址(如 `https://dav.jianguoyun.com/dav/`) |
| `--user USER` | `""` | WebDAV 用户名(通常为邮箱) |
| `--password PASS` | `""` | WebDAV 密码(坚果云需在设置中生成应用密码) |
| `--remote-path PATH` | `/` | 远程目标路径 |
## 实现原理
Sbackup 通过以下方式实现备份功能:
1. **备份策略存储**:备份策略存储在 JSON 文件中,包含文件夹路径、最后修改时间、目标路径、忽略模式和条目级打包格式。
2. **增量备份**:通过比较文件夹的最后修改时间,仅备份已更改的文件夹。
3. **多格式压缩**:使用 Python 内置的 `zipfile` 和 `tarfile` 模块,以及 `zstandard` 和 `py7zr` 第三方库,支持 7 种打包格式。
4. **条目级格式**:每个备份策略可指定独立的打包格式(`add --format`),优先于全局 `--format` 设置;未指定时使用全局默认。
5. **备份清理**:备份成功后自动扫描目标目录,按修改时间排序,删除超出保留数量的旧文件。
6. **加密备份**:7z 格式支持 LZMA2 加密,通过 `--password` 参数或 `config.json` 配置。
7. **定时备份**:`watch` 命令在循环中按指定间隔执行备份,`Ctrl+C` 安全退出。
8. **备份历史**:每次备份后记录时间戳、文件大小和文件数量,保留最近 100 条记录。
9. **SFTP 远程备份**:基于 paramiko 库实现 SFTP 客户端,支持连接测试、自动创建远程目录、带进度条的文件上传。
### 数据文件格式
```json
{
"/path/to/source/folder": [
1719235200.0,
"/path/to/target/folder",
[".git", "__pycache__"],
""
],
"/path/to/another/folder": [
1719235200.0,
"/path/to/another/target",
[".git"],
"TAR_GZ"
],
"_history": [
{
"time": "2026-05-01T12:00:00",
"source": "/path/to/source/folder",
"size_mb": 12.5,
"files_count": 150
}
]
}
```
每个备份策略条目为 4 元素列表:`[mtime, target, skip_patterns, compression_format]`
| 字段 | 说明 |
|------|------|
| `mtime` | 源文件夹最后修改时间(用于增量备份判断) |
| `target` | 备份文件存放的目标路径 |
| `skip_patterns` | 需忽略的文件/文件夹模式列表 |
| `compression_format` | 条目级打包格式(空字符串表示使用全局默认) |
## 开发指南
### 运行测试
```bash
uv run coverage run -m unittest discover -s tests -t . && uv run coverage report -m
```
### 代码结构
```
sbackup/
├── main.py # 程序入口
├── sbackup/
│ ├── __init__.py # 导出核心函数
│ ├── __main__.py # python -m sbackup 入口
│ ├── cli.py # CLI 参数解析和命令分发(30+ 命令)
│ ├── config.py # 配置加载、加密、Webhook/SMTP 配置
│ ├── auto_save.py # BackupManager 核心引擎
│ ├── compression.py # 7 种格式压缩/解压引擎
│ ├── i18n.py # 国际化(9 种语言)
│ ├── sftp.py # SFTP 远程备份客户端(paramiko)
│ ├── webdav.py # WebDAV 远程备份客户端(零依赖)
│ ├── cloud_storage.py # S3 云存储客户端(minio)
│ ├── multi_dest.py # 多目标并行备份
│ ├── handlers.py # SFTP/WebDAV/Remote/Schedule 命令处理
│ ├── hooks.py # Pre/Post Hook 执行
│ ├── audit.py # 审计日志系统
│ ├── profile.py # 配置 Profile 管理
│ ├── selective.py # 选择性恢复
│ ├── cross_search.py # 跨档案搜索
│ ├── integrity.py # SHA256 校验和
│ ├── rotation.py # 备份轮转策略
│ ├── dryrun.py # Dry-run 预览
│ ├── diskcheck.py # 磁盘空间预估
│ ├── task_queue.py # 任务队列系统
│ ├── schema.py # 配置校验器
│ ├── benchmark.py # 压缩基准测试
│ ├── chunked_backup.py# 块级增量备份
│ ├── dedup.py # 文件级 SHA256 去重
│ ├── export.py # 元数据导出(CSV/JSON)
│ ├── monitor.py # watchdog 文件系统监控
│ ├── lock.py # 跨平台进程锁
│ ├── retry.py # 指数退避重试
│ ├── ratelimiter.py # 令牌桶限速器
│ ├── keychain.py # 系统密钥链集成
│ ├── parity.py # Reed-Solomon 纠错码
│ ├── completion.py # Shell 自动补全
│ ├── wizard.py # 交互式配置向导
│ └── locales/ # 9 种语言翻译文件
└── tests/
└── sbackup/
└── test_*.py # 30 个测试文件,覆盖所有模块
```
### 添加新功能
1. 在 `sbackup/` 目录下创建新的模块文件
2. 在 `sbackup/__init__.py` 中导入新功能的函数
3. 在 `run()` 函数中添加新的命令行命令处理逻辑
4. 在 `tests/` 目录下添加对应的测试文件
## 常见问题
### Q: 备份策略文件被误删了怎么办?
A: 备份策略存储在数据文件中。如果误删,可以通过重新运行 `add` 命令重新添加备份策略。
### Q: 如何修改已添加的备份策略?
A: 使用 `sbackup edit` 命令:`sbackup edit <source> --dest <new_dest> --ignore <patterns> --format <fmt>`。
### Q: 支持远程备份吗?
A: 支持!提供三种远程备份方式:
- **SFTP**:`sbackup sftp config` 配置,`sbackup save --sftp` 上传
- **WebDAV**:`sbackup webdav config` 配置,`sbackup save --webdav` 上传(支持坚果云/NextCloud/群晖)
- **S3 云存储**:在 `config.json` 中配置 `cloud` 字段,`sbackup save --cloud` 上传
- 可同时启用多种:`sbackup save --sftp --webdav --cloud`
### Q: tar.gz 和 ZIP 有什么区别?
A: tar.gz 在 Linux/macOS 上更常用,压缩率略高;ZIP 在 Windows 上更通用,兼容性最好。tar.bz2 和 tar.xz 提供更高的压缩率但速度较慢。tar.zst 是现代算法,速度极快且压缩率不错。7z 压缩率最高且支持加密。
### Q: 如何加密备份?
A: 使用 7z 格式并设置密码:`uv run python main.py --format 7z save --password yourpassword`。密码也可以写入 `config.json` 的 `password` 字段。
### Q: 如何自动清理旧备份?
A: 使用 `--keep` 参数:`uv run python main.py save --keep 5` 只保留最近 5 个备份文件。定时备份时同样支持:`uv run python main.py watch --interval 60 --keep 10`。
### Q: 如何设置定时备份?
A: 使用 `watch` 命令:`uv run python main.py watch --interval 60` 每 60 分钟备份一次。按 `Ctrl+C` 停止。
### Q: 密码存储安全吗?
A: `config.json` 中的 SFTP 密码和 7z 加密密码均以**明文**存储。请确保 `config.json` 文件的访问权限仅限于可信用户(例如 `chmod 600 config.json`)。不要将包含密码的 `config.json` 提交到版本控制系统。
## 贡献指南
欢迎提交 Issue 和 Pull Request!
1. Fork 本仓库
2. 创建你的特性分支 (`git checkout -b feature/AmazingFeature`)
3. 提交你的更改 (`git commit -m 'Add some AmazingFeature'`)
4. 推送到分支 (`git push origin feature/AmazingFeature`)
5. 提交 Pull Request
### 代码风格
本项目遵循 PEP 8 和 Google Python Style Guide。请确保你的代码:
- 使用类型注解
- 遵循 Google 风格的 docstrings
- 通过所有单元测试
## 许可证
本项目采用 GNU GPL v3.0 许可证。详情请参阅 [LICENSE](LICENSE) 文件。
## 作者
**xiatianxuan** (CodeSeed)
- [Gitee](https://gitee.com/xiatianxuan)
- [个人主页](https://xnors-codeseed.pages.dev/)
## 特别鸣谢
- [Xnors Studio](https://xnors.github.io/)
## 联系我们
如有问题或建议,请发送邮件至:xiatianxuan2025@163.com
---
*最后更新:2026年6月19日*