shipfe 1.1.1 → 1.1.3

package/docs/zh/features/snapshot.md

@@ -1,186 +0,0 @@
-# 资源快照
-
-每个发布都会生成包含完整文件清单的快照，用于审计和回滚验证。
-
-## 快照内容
-
-- 所有部署文件及其哈希值
-- 共享资源引用
-- 部署时间戳和元数据
-- 文件权限和大小信息
-
-## 快照文件位置
-
-```
-releases/20260304_120100/
-├── files/
-│   ├── index.html
-│   └── app.js -> ../../shared/assets/abc123def456.js
-├── snapshot.json
-└── metadata.json
-```
-
-## snapshot.json 示例
-
-```json
-{
-  "timestamp": "20260304_120100",
-  "files": {
-    "index.html": {
-      "hash": "a1b2c3d4e5f6...",
-      "size": 1024,
-      "permissions": "644"
-    },
-    "app.js": {
-      "shared_hash": "abc123def456.js",
-      "size": 51200,
-      "permissions": "644"
-    }
-  }
-}
-```
-
-## metadata.json 示例
-
-```json
-{
-  "build_command": "npm run build",
-  "deployed_by": "user",
-  "deployed_at": "2026-03-04T12:01:00Z"
-}
-```
-
-## 快照用途
-
-### 审计追踪
-
-- 记录每次部署的文件清单
-- 验证文件完整性
-- 追踪部署历史
-
-### 回滚验证
-
-- 确保回滚到的版本文件完整
-- 验证共享资源引用正确
-- 检查文件权限设置
-
-### 问题诊断
-
-- 比较不同版本的文件差异
-- 识别部署问题
-- 分析性能变化
-
-## 快照生成时机
-
-- **部署时**：每次成功部署后生成
-- **回滚时**：验证目标版本的快照
-- **清理时**：检查要删除版本的快照
-
-## 快照验证
-
-Shipfe 会验证快照的完整性：
-
-- 检查文件是否存在
-- 验证哈希值匹配
-- 确认权限设置正确
-- 验证共享资源链接
-
-## 快照存储
-
-快照文件存储在每个发布目录中：
-
-- `snapshot.json` - 文件清单和哈希
-- `metadata.json` - 部署元数据
-
-## 查看快照
-
-### 本地查看
-
-```bash
-# SSH到服务器查看快照
-ssh user@server "cat /var/www/myapp/releases/20260304_120100/snapshot.json"
-```
-
-### 编程访问
-
-```javascript
-const fs = require('fs');
-const snapshot = JSON.parse(fs.readFileSync('snapshot.json', 'utf8'));
-
-console.log('Files in this release:');
-Object.entries(snapshot.files).forEach(([file, info]) => {
-  console.log(`${file}: ${info.hash} (${info.size} bytes)`);
-});
-```
-
-## 快照与共享资源
-
-当启用共享资源时，快照包含特殊处理：
-
-```json
-{
-  "files": {
-    "app.js": {
-      "shared_hash": "abc123def456.js",
-      "size": 51200,
-      "permissions": "644"
-    }
-  }
-}
-```
-
-- `shared_hash` 字段标识共享资源
-- 实际文件通过硬链接引用共享存储
-
-## 性能考虑
-
-- 快照文件很小，通常只有几KB
-- 哈希计算只对实际文件进行
-- 快照验证快速且轻量
-
-## 故障排除
-
-### 快照创建失败
-
-```
-Error: Failed to create snapshot
-```
-
-**原因**：
-- 磁盘空间不足
-- 文件权限问题
-- 哈希计算失败
-
-**解决方案**：
-- 检查磁盘空间
-- 验证文件权限
-- 查看详细错误日志
-
-### 快照验证失败
-
-```
-Warning: Snapshot validation failed
-```
-
-**原因**：
-- 文件被修改
-- 权限被改变
-- 共享资源链接损坏
-
-**解决方案**：
-- 检查文件完整性
-- 修复文件权限
-- 重新创建共享资源链接
-
-### 快照文件丢失
-
-如果快照文件丢失：
-
-- 无法验证版本完整性
-- 回滚可能失败
-- 共享资源清理受影响
-
-**恢复**：
-- 从备份恢复
-- 重新生成快照（如果可能）
-- 手动验证文件

package/docs/zh/index.md

@@ -1,65 +0,0 @@
----
-home: true
-heroImage: /logo.png
-heroText: Shipfe
-tagline: 现代化的零停机部署工具
-actionText: 快速开始 →
-actionLink: /zh/quick-start
-features:
-- title: 零停机部署
-  details: 原子化部署确保应用在部署过程中保持可用性，无缝切换到新版本。
-- title: 智能回滚
-  details: 一键回滚到之前的稳定版本，包含完整的文件快照和元数据。
-- title: 资源共享
-  details: 通过文件哈希去重减少磁盘使用和网络传输，提升部署效率。
-- title: 自动清理
-  details: 可配置的自动清理机制，保持服务器整洁并节省存储空间。
-footer: MIT Licensed | Copyright © 2024 Master-Jian
----
-
-## 快速导航
-
-<div class="features">
-  <div class="feature">
-    <h3>🚀 快速开始</h3>
-    <p>5分钟内完成安装和首次部署</p>
-    <a href="/zh/quick-start">开始使用</a>
-  </div>
-  <div class="feature">
-    <h3>⚙️ 配置指南</h3>
-    <p>了解所有配置选项和最佳实践</p>
-    <a href="/zh/config/overview">配置文档</a>
-  </div>
-  <div class="feature">
-    <h3>📚 命令参考</h3>
-    <p>完整的命令行工具使用说明</p>
-    <a href="/zh/commands/init">命令文档</a>
-  </div>
-</div>
-
-## 核心特性
-
-### 原子化部署
-每次部署都是原子操作，要么完全成功，要么完全失败，确保应用稳定性。
-
-### 智能资源管理
-- **共享资源**：相同文件只存储一次，通过硬链接节省磁盘空间
-- **增量部署**：只传输变更的文件，减少网络开销
-- **自动清理**：可配置的清理策略，防止磁盘空间浪费
-
-### 完善的回滚机制
-- **快照记录**：每个部署生成完整文件清单和元数据
-- **一键回滚**：快速恢复到任意历史版本
-- **状态验证**：确保回滚后的应用状态正确
-
-## 适用场景
-
-- **Web应用**：前端应用、API服务、微服务
-- **静态站点**：博客、文档站点、营销页面
-- **混合部署**：包含静态资源和动态服务的应用
-
-## 系统要求
-
-- **服务器**：Linux/macOS/Windows，支持SSH访问
-- **本地环境**：Node.js 16+，支持SSH密钥认证
-- **网络**：稳定的SSH连接，支持文件传输

package/docs/zh/install.md

@@ -1,160 +0,0 @@
-# 安装
-
-Shipfe 支持多种安装方式，选择最适合您的方式。
-
-## 系统要求
-
-- **操作系统**: Linux, macOS, Windows
-- **Node.js**: 版本 16 或更高
-- **SSH**: 支持密钥认证
-- **服务器**: 支持SSH访问的Linux/macOS服务器
-
-## 方式一：npm安装（推荐）
-
-### 全局安装
-
-```bash
-npm install -g shipfe
-```
-
-### 项目级安装
-
-```bash
-npm install --save-dev shipfe
-```
-
-然后在 `package.json` 中添加脚本：
-
-```json
-{
-  "scripts": {
-    "deploy": "shipfe deploy",
-    "rollback": "shipfe rollback"
-  }
-}
-```
-
-## 方式二：从源码构建
-
-### 克隆仓库
-
-```bash
-git clone https://github.com/Master-Jian/shipfe.git
-cd shipfe
-```
-
-### 安装Rust
-
-如果还没有安装Rust：
-
-```bash
-curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
-source ~/.cargo/env
-```
-
-### 构建和安装
-
-```bash
-# 构建发布版本
-cargo build --release
-
-# 安装到系统路径
-cp target/release/shipfe /usr/local/bin/shipfe
-
-# 或者安装到用户目录
-cp target/release/shipfe ~/.local/bin/shipfe
-```
-
-### 验证安装
-
-```bash
-shipfe --version
-```
-
-## 方式三：下载预构建二进制文件
-
-访问 [GitHub Releases](https://github.com/Master-Jian/shipfe/releases) 下载适合您平台的二进制文件。
-
-```bash
-# 下载并安装（以Linux x64为例）
-wget https://github.com/Master-Jian/shipfe/releases/download/v1.0.0/shipfe-linux-x64
-chmod +x shipfe-linux-x64
-sudo mv shipfe-linux-x64 /usr/local/bin/shipfe
-```
-
-## 配置自动补全（可选）
-
-### Bash
-
-```bash
-# 添加到 ~/.bashrc
-echo 'source <(shipfe completion bash)' >> ~/.bashrc
-source ~/.bashrc
-```
-
-### Zsh
-
-```bash
-# 添加到 ~/.zshrc
-echo 'source <(shipfe completion zsh)' >> ~/.zshrc
-source ~/.zshrc
-```
-
-### Fish
-
-```bash
-# 添加到 ~/.config/fish/config.fish
-echo 'shipfe completion fish | source' >> ~/.config/fish/config.fish
-```
-
-## 验证安装
-
-运行以下命令验证安装是否成功：
-
-```bash
-# 检查版本
-shipfe --version
-
-# 查看帮助
-shipfe --help
-
-# 查看所有可用命令
-shipfe --help
-```
-
-## 故障排除
-
-### 权限问题
-
-如果遇到权限错误：
-
-```bash
-# 使用sudo安装（不推荐）
-sudo npm install -g shipfe
-
-# 或者安装到用户目录
-npm config set prefix ~/.npm-global
-export PATH=~/.npm-global/bin:$PATH
-```
-
-### 网络问题
-
-如果npm安装失败，尝试使用国内镜像：
-
-```bash
-npm config set registry https://registry.npmmirror.com
-npm install -g shipfe
-```
-
-### Rust编译问题
-
-如果源码构建失败：
-
-```bash
-# 更新Rust
-rustup update
-
-# 清理并重新构建
-cargo clean
-cargo build --release
-```

package/docs/zh/license.md

@@ -1,23 +0,0 @@
-# 许可证
-
-MIT License
-
-Copyright (c) 2024 Master-Jian
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.

package/docs/zh/quick-start.md

@@ -1,109 +0,0 @@
-# 快速开始
-
-本指南将帮助您在5分钟内完成Shipfe的安装和首次部署。
-
-## 安装
-
-### 使用npm安装
-
-```bash
-npm install -g shipfe
-```
-
-### 从源码构建
-
-```bash
-git clone https://github.com/Master-Jian/shipfe.git
-cd shipfe
-cargo build --release
-cp target/release/shipfe /usr/local/bin/shipfe
-```
-
-## 初始化项目
-
-在您的项目根目录下运行：
-
-```bash
-shipfe init
-```
-
-这将创建 `shipfe.config.json` 配置文件。
-
-## 配置
-
-编辑 `shipfe.config.json`：
-
-```json
-{
-  "remote_host": "your-server.com",
-  "remote_user": "deploy",
-  "remote_path": "/var/www/myapp",
-  "local_path": "./dist",
-  "keep_releases": 5,
-  "build_command": "npm run build"
-}
-```
-
-### 配置说明
-
-- `remote_host`: 服务器地址
-- `remote_user`: SSH用户名
-- `remote_path`: 服务器部署目录
-- `local_path`: 本地构建输出目录
-- `keep_releases`: 保留的发布版本数量
-- `build_command`: 构建命令
-
-## SSH密钥配置
-
-确保您的SSH密钥已添加到服务器：
-
-```bash
-# 本地生成SSH密钥（如果还没有）
-ssh-keygen -t rsa -b 4096 -C "your-email@example.com"
-
-# 复制公钥到服务器
-ssh-copy-id user@your-server.com
-```
-
-## 首次部署
-
-运行构建和部署：
-
-```bash
-shipfe deploy
-```
-
-Shipfe将：
-1. 执行构建命令
-2. 创建新的发布目录
-3. 上传文件到服务器
-4. 原子化切换到新版本
-5. 清理旧版本
-
-## 验证部署
-
-检查部署状态：
-
-```bash
-# 查看服务器上的发布
-ssh user@server "ls -la /var/www/myapp/releases/"
-
-# 检查当前符号链接
-ssh user@server "ls -la /var/www/myapp/current"
-```
-
-## 回滚（如果需要）
-
-如果部署出现问题，可以快速回滚：
-
-```bash
-shipfe rollback
-```
-
-这将自动切换到上一个稳定版本。
-
-## 下一步
-
-- [配置详解](/zh/config/overview) - 了解所有配置选项
-- [命令参考](/zh/commands/deploy) - 掌握所有命令
-- [故障排除](/zh/troubleshooting) - 解决常见问题

package/docs/zh/troubleshooting.md

@@ -1,88 +0,0 @@
-# 故障排除
-
-## 常见问题
-
-### 1. 权限拒绝错误
-
-```
-Error: Permission denied (publickey)
-```
-
-**解决方案：**
-- 验证 SSH 密钥已添加到服务器的 `~/.ssh/authorized_keys`
-- 检查 SSH 密钥权限：`chmod 600 ~/.ssh/id_rsa`
-- 测试 SSH 连接：`ssh user@host`
-
-### 2. 共享资源不工作
-
-```
-Warning: Failed to create hard link for shared asset
-```
-
-**解决方案：**
-- 确保配置中 `enable_shared: true`
-- 检查服务器文件系统支持硬链接
-- 验证 shared 目录的写入权限
-
-### 3. 清理不工作
-
-```
-Warning: Failed to remove old release
-```
-
-**解决方案：**
-- 检查 releases 目录的文件权限
-- 确保没有进程正在使用旧发布文件
-- 验证 `keep_releases` 设置正确
-
-### 4. 快照创建失败
-
-```
-Error: Failed to create snapshot
-```
-
-**解决方案：**
-- 检查可用磁盘空间
-- 验证 releases 目录的写入权限
-- 确保服务器上有 tar 命令
-
-## 调试模式
-
-启用详细日志：
-
-```bash
-shipfe deploy --debug
-```
-
-## 日志路径
-
-Shipfe 的日志文件通常位于：
-
-- 本地：`shipfe.log`
-- 服务器：部署目录下的 `shipfe.log`
-
-检查日志：
-
-```bash
-tail -f shipfe.log
-```
-
-## 性能优化
-
-### 部署缓慢
-
-- 为大静态文件启用共享资源
-- 使用 `hashed_asset_patterns` 针对特定文件
-- 考虑从模式中排除大的非更改文件
-
-### 磁盘使用过高
-
-- 减少 `keep_releases` 数量
-- 启用共享资源
-- 对单发布部署使用 `delete_old: true`
-
-### 网络问题
-
-- 部署前压缩大文件
-- 如果支持，使用更快的 SSH 密码
-- 考虑在非高峰时段部署