README

这是一个用于与Joomlatools Console一起使用的Capistrano项目的简单包装命令。

插件添加了capistrano:deploy命令，您可以使用它快速将任何之前配置的项目部署到您的服务器。

安装

• 运行以下命令

  $ joomla plugin:install joomlatools/console-capistrano

• 验证插件是否可用

  $ joomla plugin:list

• 您现在可以通过以下方式部署现有的Capistrano项目：

  $ joomla capistrano:deploy sitename

• 如果您尚未设置现有的Capistrano项目，则插件会为您创建一个。请参阅入门说明了解如何配置：[https://capistrano.ruby-lang.org.cn/documentation/getting-started/installation/](https://capistrano.ruby-lang.org.cn/documentation/getting-started/installation/)

• 要获取可用选项，请运行

  $ joomla help capistrano:deploy

要求

为了使Capistrano能够工作，您必须满足以下条件

• 配置您的远程机器与Capistrano协同工作：[https://capistrano.ruby-lang.org.cn/documentation/getting-started/authentication-and-authorisation/](https://capistrano.ruby-lang.org.cn/documentation/getting-started/authentication-and-authorisation/)
• 本地vagrant盒子和远程服务器之间的SSH访问通过部署用户帐户
• 本地vagrant盒子和您的GitHub帐户之间的SSH访问
• 从现在起，在您的Joomlatools Vagrant盒子中克隆的GitHub存储库称为您的'项目'

Capistrano将您的项目部署到服务器上当前/目录的符号链接中，因此您需要再次通过符号链接将文档根目录设置为该文件夹。

在您的远程机器上，您需要安装以下内容

• Ruby >= 1.9

所需的Gem

• capistrano (> 3.1.0)
• capistrano-composer

您可以使用gem install <gem name>手动安装这些。

初始化

要使您的项目成为Capistrano启用的项目，请通过vagrant终端发出以下命令

$ joomla capistrano:deploy sitename

将sitename替换为您本地项目的名称。

如果您的项目已经配置为与Capistrano协同工作，则您可以通过以下命令将项目capify到任何预配置的环境

$ joomla capistrano:deploy sitename -e staging

将staging替换为/config/deploy中找到的任何预配置环境

但是，如果没有找到Capistrano项目，则将创建一个新的Capistrano项目。

配置

初始化您的Capistrano项目将为您提供两个基本配置文件/环境（生产环境和测试环境），您可以进行配置。

这两个环境之间通用的配置设置可以在以下位置进行

• config/deploy/deploy.rb

这样的通用设置可以是您的应用程序名称和您将使用的git仓库

set :application, "Capistrano"

set :repo_url, "git@github.com:foo/bar.git"

环境特定细节，应在以下文件中设置

• config/deploy/production.rb
• config/deploy/staging.rb

以下是一个示例配置

set :stage_url, "http://www.example.com"
server "XXX.XXX.XX.XXX",
user: "SSHUSER", roles: %w{web app db}
set :deploy_to, "/deploy/to/path"
set :branch, "master"

Capistrano非常可配置！要查看选项的完整列表，请访问以下页面：https://capistrano.ruby-lang.org.cn/documentation/getting-started/configuration/

如果您需要连接到其他环境，只需复制这些环境配置之一（config/deploy/*.rb文件），适当命名，并根据您的需求进行配置。

.gitignore

初始化Capistrano将在您的本地项目中添加两个文件夹

• /.capistrano
• /config

以及在项目根目录中添加一个文件

• Capfile

您需要将这些文件和文件夹添加到您的.gitignore中，以避免将敏感信息提交到您的仓库。

用法

一旦您的本地Capistrano项目配置完成，您就可以通过以下命令轻松部署您的项目

$ joomla capistrano:deploy sitename -e staging

或

$ joomla capistrano:deploy sitename -e production

要查看选项的完整列表，请运行

$ joomla help capistrano:deploy

贡献

此插件是一个开源、社区驱动的项目。欢迎所有人的贡献。我们有贡献指南来帮助您开始。

贡献者

查看贡献者列表。

许可证

此插件是免费和开源软件，根据MPLv2许可证许可。

社区

跟踪开发和社区新闻。

• 关注@joomlatoolsdev在Twitter上的动态
• 加入joomlatools/dev在Gitter上的讨论
• 阅读Joomlatools开发者博客
• 订阅Joomlatools开发者通讯