远程连接

• 配置文件
• 基本用法
• 任务
• SFTP 下载
• SFTP 上传
• 编辑远程日志
• Envoy 任务执行

配置文件

Laravel 可以简单的通过 SSH 方式登录到远程服务器并执行相关操作命令，让您可以简单在远程执行的建立 Artisan 任务。SSH facade 提供了此类行为的入口。

相关的配置文件存在 app/config/remote.php 中，此文件包含所有您需要设定的远程连接配置， connections 数组里有以远程服务器名称作为键值的列表。只要在 connections 数组设定好认证，您就准备好可以执行远程任务了。记得 SSH 可以使用密码或 SSH key 进行身份认证。

提示: 需要在远程服务器执行很多任务吗？请阅读 Envoy 任务执行!

基本用法

在在默认服务器执行命令

使用 SSH::run 方法，在默认的远程服务器执行命令：

SSH::run(array(
    'cd /var/www',
    'git pull origin master',
));

在特定服务器执行命令

您也可以使用 into 方法在特定的服务器上执行命令：

SSH::into('staging')->run(array(
    'cd /var/www',
    'git pull origin master',
));

捕捉命令的输出

您可以经由传入闭合函数到 run 方法，捕捉远程命令的即时输出：

SSH::run($commands, function($line)
{
    echo $line.PHP_EOL;
});

任务

如果您需要定义一组一起执行的命令，您可以用 define 方法定义一个「任务」：

SSH::into('staging')->define('deploy', array(
    'cd /var/www',
    'git pull origin master',
    'php artisan migrate',
));

您可以用 task 方法执行定义过的任务：

SSH::into('staging')->task('deploy', function($line)
{
    echo $line.PHP_EOL;
});

SFTP 下载

SSH 类里有简单的方式可以下载文件，使用 get 和 getString 方法：

SSH::into('staging')->get($remotePath, $localPath);

$contents = SSH::into('staging')->getString($remotePath);

SFTP 上传

SSH 类里也有简单的方式可以上传文件或甚至是字串到远程服务器，使用 put 和 putString 方法：

SSH::into('staging')->put($localFile, $remotePath);

SSH::into('staging')->putString($remotePath, 'Foo');

编辑远程日志

Laravel 有一个有用的命令可以让您在任何远程服务器的 laravel.log 尾端附加日志内容。使用 Artisan 的 tail 命令以及指定远程连线的服务器名称：

php artisan tail staging

php artisan tail staging --path=/path/to/log.file

Envoy 任务执行

• 安装
• 执行任务
• 多服务器
• 平行执行
• 任务宏
• 提醒通知
• 更新 Envoy

Laravel Envoy 提供了简洁，轻量的语法能让您对远程服务器执行任务操作。使用 Blade 风格的语法，您可以简单的设置部署任务，执行 Artisan 命令。

提醒: Envoy 需要 PHP 5.4 或更高的版本，并且只能在 Mac / Linux 发行版本下执行。

安装

首先，使用 Composer global 命令安装 Envoy ：

composer global require "laravel/envoy=~1.0"

记得将 ~/.composer/vendor/bin 路径加入 PATH，如此在终端机执行 envoy 命令时才找得到。

再来，在项目根目录建立 Envoy.blade.php 文件。这里有个例子可以让您作为示例：

@servers(['web' => '192.168.1.1'])

@task('foo', ['on' => 'web'])
    ls -la
@endtask

如您所见，@servers 数组建立在文件的开头。您可以在定义任务时，在 on 选项里参照这些服务器。在您的 @task 定义里，写入想要在远程服务器执行的 Bash code。

init 命令可以简单的建立一个基本的 Envoy 文件：

envoy init user@192.168.1.1

执行任务

以 envoy 的 run 命令去执行您设定的任务：

envoy run foo

如有需要，您可以传递命令行参数到 Envoy 文件：

envoy run deploy --branch=master

您也可以经由您所熟悉的 Blade 语法使用这些参数：

@servers(['web' => '192.168.1.1'])

@task('deploy', ['on' => 'web'])
    cd site
    git pull origin {{ $branch }}
    php artisan migrate
@endtask

Bootstrapping

您可以在 Envoy 文件里使用 @setup 语法定义 PHP 变量和执行一般的 PHP 代码：

@setup
    $now = new DateTime();

    $environment = isset($env) ? $env : "testing";
@endsetup

您也可以使用 @include 引入 PHP 文件：

@include('vendor/autoload.php');

多服务器

您可以简单的在多个服务器执行任务。只要在任务定义里列出服务器名称：

@servers(['web-1' => '192.168.1.1', 'web-2' => '192.168.1.2'])

@task('deploy', ['on' => ['web-1', 'web-2']])
    cd site
    git pull origin {{ $branch }}
    php artisan migrate
@endtask

默认任务会循序的在每个服务器上执行。意味着任务会在第一个服务器执行完后才会换到下一个。

平行执行

如果您想在多个服务器上同时执行任务，只要简单的在任务定义里加上 parallel 选项：

@servers(['web-1' => '192.168.1.1', 'web-2' => '192.168.1.2'])

@task('deploy', ['on' => ['web-1', 'web-2'], 'parallel' => true])
    cd site
    git pull origin {{ $branch }}
    php artisan migrate
@endtask

任务宏

宏让您可以使用一个命令就循序执行一组任务。例如：

@servers(['web' => '192.168.1.1'])

@macro('deploy')
    foo
    bar
@endmacro

@task('foo')
    echo "HELLO"
@endtask

@task('bar')
    echo "WORLD"
@endtask

现在 deploy 宏可以经由一个简单的命令执行：

envoy run deploy

提醒通知

HipChat

您可能想要在执行完任务后，发送通知到团队的 HipChat 聊天室，使用简单的 @hipchat 定义：

@servers(['web' => '192.168.1.1'])

@task('foo', ['on' => 'web'])
    ls -la
@endtask

@after
    @hipchat('token', 'room', 'Envoy')
@endafter

您也可以自定义发送到 hipchat 聊天室的信息，任何在 @setup 里定义，或是经由 @include 引入的变量都可以使用在信息里：

@after
    @hipchat('token', 'room', 'Envoy', "$task ran on [$environment]")
@endafter

这是一个令人惊艳的简单方式，让您的团队保持通知在服务器执行的任务。

Slack

下面的语法可以发送通知到 Slack：

@after
    @slack('team', 'token', 'channel')
@endafter

更新 Envoy

简单的执行 self-update 命令即可更新 Envoy：

envoy self-update

如果您的 Envoy 安装在 /usr/local/bin，您可能需要加上 sudo：

composer global update