.docs

Deployer Extension

Content

• Usage - how to register
• Configuration - how to configure
• Listeners
• Deploy - how to deploy
• Plugins

Usage

extensions:
	deployer: Contributte\Deployer\DI\DeployerExtension

Configuration

Detailed configuration is described here ftp-deployment.

parameters:
	deploy:
		protocol: ftp # ftp|ftps
		user: user1
		password: mysecretpwd
		scheme: example.com # example.com/www

deployer:
	config:
		mode: run
		logFile: %appDir%/log/deployer.log
		tempDir: %appDir%/temp
		colors: off

	# User specific variables
	userdata:

	# Plugins specification (see more in PLUGINS.md)
	plugins:

	# Web sections
	sections:
		web1:
			remote: %deploy.protocol%://%deploy.user%:%deploy.password%@%deploy.scheme%
			local: %wwwDir%
			testMode: false

			allowdelete: on
			passiveMode: on
			preprocess: off

			ignore:
				# Common
				- .git*
				- .idea*
				- .bowerrc
				- composer.*
				- bower.json
				- gulpfile.js
				- package.json

				# Application
				- /app/config/config.local.neon
				- /bin
				- /tests
				- /node_modules
				- /log/*
				- "!/log/.htaccess"
				- /temp/*
				- "!/temp/.htaccess"

				# Public
				- /www/*.scss
				- /www/*.less
				- /www/temp
				- /www/uploaded
				- /www/stats

			before:
				#- [@\TestBeforeListener, onBefore]
			after:
				#- [@\TestAfterListener, onAfter]

			purge:
				- temp/cache
				- temp/myfolder

More webs <=> more sections

deployer:
	section:
		example.com:
			...
		test.cz:
			...

Listeners

You can register service which implement AfterListener or BeforeListener.

Example you can find here.

Or in plugins section here.

Deploy

See example scripts here.

Automatic

Config is automatic passed via extension.

# Create Deploy Manager
$dm = $container->getByType('Contributte\Deployer\Manager');
$dm->deploy();

Manual

You have to create your configuration by yourself.

# Create config
$config = new Config();
$config->setLogFile(..);
$config->setMode(..);

$section = new Section();
$section->setName(..);
$config->addSection($section);

# Create Deploy Manager
$dm = $container->getByType('Contributte\Deployer\Manager');
$dm->manualDeploy($config);

# Inject Deploy Manager
use Contributte\Deployer;

/** @var Deployer\Manager @inject */
public $dm;

public function actionDeploy()
{
	$this->dm->manulDeploy($config);
}

Prepared deploy script (deploy.php & deploy)

Place it by yourself (for example root/deploy.php). Be careful about local and tempDir, there depend on location.

require __DIR__ . '/vendor/autoload.php';

# Configurator
$configurator = new Nette\Configurator;
$configurator->setDebugMode(TRUE);
$configurator->enableDebugger(__DIR__ . '/../log');
$configurator->setTempDirectory(__DIR__ . '/../temp');
$configurator->createRobotLoader()
	->addDirectory(__DIR__)
	->register();

# Configs
$configurator->addConfig(__DIR__ . '/config/config.neon');

# Create DI Container
$container = $configurator->createContainer();

# Create Deploy Manager
$dm = $container->getByType('Contributte\Deployer\Manager');
$dm->deploy();

Plugins

MaintenanceListener

This is prepared listener that help make maintenance mode easier.

Plugin has two sections rewrite and rename.

You have to register to before and to after also (!).

Rewrite

Before: backup origin file, rename destination file to source file

After: revert rewriting

deployer:
	plugins:
		maintenance:
			rewrite:
				- [www/index.php, www/index.maintenance]

Rename

Before: rename origin file to destination file

After: revert renaming

deployer:
	plugins:
		maintenance:
			rename:
				- [www/.maintenance.php, www/maintenance.php]

You can combine rewriting and renaming together.

ComposerInstallListener

This is prepared listener that runs command:

composer install --no-dev --prefer-dist --optimize-autoloader -d $DIR

Parameters

• $DIR is section.local

ComposerUpdateListener

This is prepared listener that runs command:

composer update --no-dev --prefer-dist --optimize-autoloader -d $DIR

Parameters

• $DIR is section.local