Skip to content

Latest commit

 

History

History
54 lines (37 loc) · 1.67 KB

README.md

File metadata and controls

54 lines (37 loc) · 1.67 KB
Raw

dokku-airbrake-deploy

dokku-airbrake-deploy is a plugin for dokku that notifies Airbrake (or Errbit) that your application has been deployed.

Requirements

curl is required and will be installed when calling dokku plugins-install.

Installation

# dokku 0.3.26
$ sudo git clone https://github.com/Flink/dokku-airbrake-deploy.git /var/lib/dokku/plugins/airbrake-deploy
$ dokku plugins-install

# dokku 0.4+
$ dokku plugin:install https://github.com/Flink/dokku-airbrake-deploy.git

Commands

$ dokku help
    airbrake-deploy <app>   Display the current airbrake deploy hook status of app

Usage

Checking if deploy hook is enabled or not on your application:

# dokku airbrake-deploy my-app            # Server side
$ ssh dokku@server airbrake-deploy my-app # Client side

AIRBRAKE_API_KEY is not defined for my-app
$

To enable deploy hook for you application, you just have to set AIRBRAKE_API_KEY:

# dokku config:set my-app AIRBRAKE_API_KEY=your_api_key            # Server side
$ ssh dokku@server config:set my-app AIRBRAKE_API_KEY=your_api_key # Client side

By default the repository URL provided will be the one from dokku ([email protected]:my-app). To change that, just set AIRBRAKE_REPO_URL to your real repository (eg. [email protected]/user/repo.git).

This plugin is also compatible with Errbit, set AIRBRAKE_BASE_URL to your errbit installation to notify it (eg. https://my.errbit.net).

License

This plugin is released under the MIT license. See the file LICENSE.