SuperDeploy 技术文档

1. 安装指南

SuperDeploy 是一个基于 Capistrano 的部署插件，提供了多种实用的任务脚本，帮助开发者简化部署流程。以下是安装步骤：

1. 确保你已经安装了 Capistrano。如果尚未安装，可以通过以下命令安装：

   gem install capistrano
   

2. 在你的项目目录中，使用以下命令安装 SuperDeploy 插件：

   script/plugin install git://github.com/saizai/superdeploy.git
   

3. 安装完成后，可以通过以下命令查看所有可用的任务：

   cap -T
   

2. 项目的使用说明

SuperDeploy 提供了多种实用的任务，帮助开发者简化部署和日志监控。以下是一些常用任务的说明：

日志监控任务

• cap log: 显示未过滤的统一日志。
• cap log:short: 显示过滤后的日志，仅包含处理行和错误信息。
• cap log:google: 显示 Google Analytics 风格的参数统计信息。
• cap log:google_subtotals: 显示每个活动的子总计。
• cap log:smart: 实时显示网站的访问量、错误信息、加载时间等。

部署任务

• cap deploy: 部署项目。
• cap deploy:check: 检查部署依赖。
• cap deploy:cleanup: 清理旧的发布版本。
• cap deploy:cold: 部署并启动一个“冷”应用程序。
• cap deploy:migrate: 运行数据库迁移任务。
• cap deploy:rollback: 回滚到上一个版本。

系统任务

• cap sys:apt:install: 使用 aptitude 安装软件包。
• cap sys:gems:install: 在发布服务器上安装 gem。
• cap sys:uname: 检查系统 uname 信息。

3. 项目API使用文档

SuperDeploy 的 API 主要通过 Capistrano 的任务命令来调用。以下是一些常用 API 的说明：

日志监控 API

• cap log: 显示未过滤的统一日志。
• cap log:short: 显示过滤后的日志，仅包含处理行和错误信息。
• cap log:google: 显示 Google Analytics 风格的参数统计信息。
• cap log:google_subtotals: 显示每个活动的子总计。
• cap log:smart: 实时显示网站的访问量、错误信息、加载时间等。

部署 API

• cap deploy: 部署项目。
• cap deploy:check: 检查部署依赖。
• cap deploy:cleanup: 清理旧的发布版本。
• cap deploy:cold: 部署并启动一个“冷”应用程序。
• cap deploy:migrate: 运行数据库迁移任务。
• cap deploy:rollback: 回滚到上一个版本。

系统 API

• cap sys:apt:install: 使用 aptitude 安装软件包。
• cap sys:gems:install: 在发布服务器上安装 gem。
• cap sys:uname: 检查系统 uname 信息。

4. 项目安装方式

SuperDeploy 的安装方式非常简单，只需通过以下命令即可完成安装：

script/plugin install git://github.com/saizai/superdeploy.git

安装完成后，可以通过 cap -T 命令查看所有可用的任务。

---

通过以上文档，你应该能够顺利安装和使用 SuperDeploy 插件，简化你的部署流程并提高开发效率。