ZFDeploy is a command line tool to deploy Zend Framework 2 applications.
This tool produces a file package ready to be deployed. The tool supports the following format: ZIP, TAR, TGZ (.TAR.GZ), .ZPK (the deployment file format of Zend Server 6).
ZFDeploy may be installed in two ways: as a standalone, updatable phar
file,
or via Composer.
The standalone phar
file is available at:
You can retrieve it using any of the following commands.
Via curl
:
$ curl -o zfdeploy.phar https://packages.zendframework.com/zf-deploy/zfdeploy.phar
Via wget
:
$ wget https://packages.zendframework.com/zf-deploy/zfdeploy.phar
Or using your installed PHP binary:
$ php -r "file_put_contents('zfdeploy.phar', file_get_contents('https://packages.zendframework.com/zf-deploy/zfdeploy.phar'));"
Once you have the file, make it executable; in Unix-like systems:
$ chmod 755 zfdeploy.phar
You can update the phar
file periodically to the latest version using the self-update
command:
$ zfdeploy.phar self-update
Run the following composer
command:
$ composer require "zfcampus/zf-deploy:~1.0-dev"
Alternately, manually add the following to your composer.json
, in the require
section:
"require": {
"zfcampus/zf-deploy": "~1.0-dev"
}
And then run composer update
to ensure the module is installed.
If installed via composer, the script lives in vendor/bin/zfdeploy.php
of your application.
If you clone this project standalone, the script is located in
bin/zfdeploy.php
. If you install this repository as a Composer dependency of your project, the script is located invendor/bin/zfdeploy.php
. If you install using thephar
file, you will either need to put it on your path or provide the full path to thephar
file; the script name then iszfdeploy.phar
.Depending on your environment, you may need to execute the
phar
file orphp
script using yourphp
executable:$ php bin/zfdeploy.php $ php vendor/bin/zfdeploy.php $ php zfdeploy.pharIn most Unix-like systems, if you have
/usr/bin/env
available, both the script andphar
file should be self-executable.For our examples, we will reference the script as
zfdeploy
, regardless of how you installed it or how you determine you will need to execute it.
The command line tool can be executed using the following command:
$ zfdeploy build <package>
where <package>
is the filename of the output package to produce. When run with no other
arguments, it assumes the current directory should be packaged; if you want to specify a different
directory for packaging, use the --target
flag:
$ zfdeploy build <package> --target path/to/application
You can specify the file format directly in the <package>
using the proper extension (e.g.
application.zip
will create a ZIP file).
zfdeploy
includes the following commands:
$ zfdeploy
ZFDeploy, version 0.3.0-dev
Available commands:
build Build a deployment package
help Get help for individual commands
self-update Updates zfdeploy.phar to the latest version
version Display the version of the script
The full syntax of the build
command includes:
Usage:
build <package> [--target=] [--modules=] [--vendor|-v]:vendor [--composer=] [--gitignore=] [--deploymentxml=] [--zpkdata=] [--version=]
Arguments:
<package> Name of the package file to create; suffix must be .zip, .tar, .tar.gz, .tgz, or .zpk
--target The target directory of the application to package; defaults to current working directory
--modules Comma-separated list of modules to include in build
--vendor|-v Whether or not to include the vendor directory (disabled by default)
--composer Whether or not to execute composer; "on" or "off" ("on" by default)
--gitignore Whether or not to parse the .gitignore file to determine what files/folders to exclude; "on" or "off" ("on" by default)
--deploymentxmlPath to a custom deployment.xml to use when building a ZPK package
--zpkdata Path to a directory containing ZPK package assets (deployment.xml, logo, scripts, etc.)
--version Specific application version to use for a ZPK package
This deployment tool takes care of the local configuration files, related to the specific
environment, using the .gitignore
file. If your applications use the .gitignore
file to exclude
local configuration files, for instance the local.php
file in the /config/autoload
folder,
ZFdeploy will not include these files in the deployment package. You can disable the usage of
the .gitignore
file using the --gitignore off
option.
If you disable the
.gitignore
using the--gitignore off
option, all the files of the ZF2 application will be included in the package. That means local configuration files, including sensitive information like database credentials, are deployed in production!!! Please consider this behaviour before switching off the gitignore option.
Another important part of the deployment of a ZF2 application is the usage of composer.
ZFDeploy executes the following composer command during the creation of the deployment package:
$ php composer.phar install --no-dev --prefer-dist --optimize-autoloader
The --no-dev
flag ensures that development packages are not installed in the production
environment. The --prefer-dist
option tell composer to install from dist if possible. This can
speed up installs substantially on build servers and other use cases where you typically do not run
updates of the vendors The --optimize-autoloader
flag makes Composer's autoloader more performant
by building a "class map".
For more information about Composer, you can read the Documentation page of the project.
The help
command can list both the available commands, as well as provide the syntax for each
command:
zfdeploy help
will list all commands available.zfdeploy help <command>
will show usage for the named command.