Strano 技术文档

Strano 是一个基于 Github 的 Capistrano 部署管理 UI，允许用户通过简洁的 Web 界面运行任何 Capistrano 任务。本文档将详细介绍 Strano 的安装、使用、API 以及配置方法，帮助用户快速上手并深入了解该项目。

1. 安装指南

Strano 是一个基于 Rails 的应用程序，使用 Sidekiq 作为后台任务处理引擎。以下是安装步骤：

1. 克隆仓库
   首先，从 Github 克隆 Strano 仓库：

   git clone https://github.com/joelmoss/strano.git
   

2. 安装依赖
   进入项目目录并运行安装脚本：

   cd strano
   script/bootstrap
   

3. 启动应用
   安装完成后，启动 Rails 应用：

   bundle exec rails s
   

注意：Strano 无法在 Heroku 上运行，因为项目仓库需要克隆到应用本地的 vendors/repos 目录中。

2. 项目的使用说明

Strano 的使用非常简单，以下是基本的使用步骤：

1. 创建项目
   在 Strano 的 Web 界面中，创建一个项目并关联到你的 Github 仓库。Strano 会自动使用仓库中的 Capistrano 配置。

2. 运行任务
   通过 Web 界面选择并运行 Capistrano 任务。所有任务都会被记录，方便后续查看历史记录。

3. 查看历史
   在任务历史页面，你可以查看所有任务的执行记录，包括执行人、执行时间和任务详情。

3. 项目 API 使用文档

Strano 目前没有公开的 API 文档，但你可以通过查看源代码或项目 Wiki 来了解其内部 API 的使用方法。如果你有 API 相关的需求，建议直接查看项目的源代码或提交 Issue 进行讨论。

4. 项目配置

Strano 的配置非常简单，只需定义三个必需的配置变量，其余配置可以根据需要进行覆盖。

1. Github Key 和 Secret
   创建一个 Github 应用，并将生成的 Key 和 Secret 分别配置为 github_key 和 github_secret。

2. Public SSH Key
   为了从 Github 克隆仓库，需要在 public_ssh_key 中配置一个公钥。

3. 配置文件
   你可以通过创建 config/strano.yml 文件或在环境变量中定义这些配置。参考 config/strano.example.yml 文件了解所有可配置的变量。

5. 后台任务处理

Strano 使用 Sidekiq 处理后台任务。你可以通过以下命令启动 Sidekiq 队列：

bundle exec sidekiq

启动后，你可以通过 http://YOUR-STRANO-APP/sidekiq 监控任务队列。

6. 贡献指南

如果你希望为 Strano 贡献代码，请遵循以下步骤：

1. Fork Strano 仓库。
2. 创建一个主题分支：

   git checkout -b my_branch
   

3. 推送你的分支：

   git push origin my_branch
   

4. 创建一个 Pull Request。

7. 许可证

Strano 采用 MIT 许可证发布，详细信息请参考 MIT 许可证文档。

---

通过本文档，你应该能够顺利安装、配置并使用 Strano。如果你有任何问题或建议，欢迎通过 Github 提交 Issue 或 Pull Request。