Skip to main content
Version: 7.x

common

Source

Configuration

user

Source

Name of current user who is running deploy. If not set will try automatically get git user name, otherwise output of whoami command.

keep_releases

Source

Number of releases to preserve in releases folder.

Default value
10

repository

Source

Repository to deploy.

default_timeout

Source

Default timeout for run() and runLocally() functions.

Set to null to disable timeout.

Default value
300

env

Source

Remote environment variables.

set('env', [
'KEY' => 'something',
]);

It is possible to override it per run() call.

run('echo $KEY', env: ['KEY' => 'over']);

dotenv

Source

Path to .env file which will be used as environment variables for each command per run().

set('dotenv', '{{current_path}}/.env');
Default value
false

deploy_path

Source

The deploy path.

For example can be set for a bunch of host once as:

set('deploy_path', '~/{{alias}}');

current_path

Source

Return current release path. Default to deploy_path/current.

set('current_path', '/var/public_html');
Default value
'{{deploy_path}}/current'

bin/php

Source

Path to the php bin.

bin/git

Source

Path to the git bin.

Source

Should bin/symlink use --relative option or not. Will detect automatically.

Source

Path to the ln bin. With predefined options -nfs.

sudo_askpass

Source

Path to a file which will store temp script with sudo password. Defaults to .dep/sudo_pass. This script is only temporary and will be deleted after sudo command executed.

target

Source

The deploy target: a branch, a tag or a revision.

Tasks

deploy:prepare

Source

Prepares a new release.

This task is group task which contains next tasks:

deploy:publish

Source

Publishes the release.

This task is group task which contains next tasks:

deploy:success

Source

Prints success message

deploy:failed

Source

Hook on deploy failure.

logs:app

Source

Shows application logs.

Follows latest application logs.



Support Deployer โค๏ธ

Hello, my name is Anton Medvedev. I'm the creator of the Deployer. I maintain this open source project in my spare time. Supporters on GitHub give me extra motivation to work on the project.

Consider supporting Deployer via GitHub Sponsors.