Download the PHP package zfcampus/zf-deploy without Composer
On this page you can find all versions of the php package zfcampus/zf-deploy. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download zfcampus/zf-deploy
More information about zfcampus/zf-deploy
Files in zfcampus/zf-deploy
Package zf-deploy
Short Description Deployment tool for Zend Framework applications
License BSD-3-Clause
Informations about the package zf-deploy
ZFDeploy - deploy ZF applications
Repository abandoned 2019-12-31
This repository is abandoned, and has no replacement provided.
Introduction
ZFDeploy is a command line tool to deploy Zend Framework 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).
Requirements
Please see the composer.json file.
Installation
ZFDeploy may be installed in two ways: as a standalone, updatable phar
file,
or via Composer.
Standalone PHAR installation
The standalone phar
file is available at:
You can retrieve it using any of the following commands.
Via curl
:
Via wget
:
Or using your installed PHP binary:
Once you have the file, make it executable; in Unix-like systems:
You can update the phar
file periodically to the latest version using the self-update
command:
Composer installation
Run the following composer
command:
Alternately, manually add the following to your composer.json
, in the require
section:
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.
Usage
Note
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:In 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:
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:
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:
The full syntax of the build
command includes:
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.
NOTE: if you disable the .gitignore usage
If you disable the
.gitignore
using the--gitignore off
option, all the files of the ZF 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 ZF application is the usage of composer.
ZFDeploy executes the following composer command during the creation of the deployment package:
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.
Note: production configuration
Zend Framework applications often include
{,*.}local.php
files inconfig\autoload/
, which are used to provide environment specific configuration. (In Apigility, this may include database configuration, Authentication configuration, etc.). These files are omitted from version control via.gitignore
directives -- and, by default, from packaging.The settings you want for production will often differ from those in your development environment, and you may push them to production in a variety of ways -- via Chef, Puppet, Ansible, etc. Another option is to use the
--configs
flag when building your package. You can pass a directory containing production configuration files, and these will then be included in your deployment package.
Getting help
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.
All versions of zf-deploy with dependencies
herrera-io/phar-update Version ~1.0
zendframework/zend-filter Version ^2.7.1
zfcampus/zf-console Version ^1.3