deployer/docs/contrib/rabbit.md
Anton Medvedev 47a193f9af
Add docgen
2020-10-02 01:11:13 +03:00

1.3 KiB

rabbit

Source

Installing

deploy.php

require 'recipe/rabbit.php';

Configuration options

  • rabbit (required): accepts an array with the connection information to rabbitmq server token and team name.

You can provide also other configuration options:

  • host - default is localhost
  • port - default is 5672
  • username - default is guest
  • password - default is guest
  • channel - no default value, need to be specified via config
  • message - default is Deployment to '{$host}' on {$prod} was successful\n($releasePath)
  • vhost - default is
deploy.php

set('rabbit', [
    'host'     => 'localhost',
    'port'     => '5672',
    'username' => 'guest',
    'password' => 'guest',
    'channel'  => 'notify-channel',
    'vhost'    => '/my-app'
]);

Suggested Usage

Since you should only notify RabbitMQ channel of a successful deployment, the deploy:rabbit task should be executed right at the end.

deploy.php

before('deploy:end', 'deploy:rabbit');
  • Tasks

Tasks

deploy:rabbit

Source