Packaging for php (and other) projects.
How to use it
- cd to your project directory
- git clone git://github.com/liip/packaging.git
- cp packaging/packaging_config.php.sample packaging_config.php
- edit the configuration file to suit your needs (see the section Configuration options below for more information)
Now you should have the deb/rpm package in your tmp/yourpackage directory.
Hint: You can pass an optional argument 'ENV' to the 'make' command: make ENV=prod
This way you can distinguish between different installation environments (i.e production and staging). You can then use this variable in you package_config.php to distinguish between files that should be used in a production environment or in a staging environment.
$filemapping = array( 'var/www/@PACKAGENAME@' => array( '*', '- /packaging_files', ), 'etc/packaged-site/@PACKAGENAME@' => array( // This file is used as a template file that holds environment-dependent // information 'packaging_files/config.$(ENV).m4', ), );
The packaging process depends on the following to external programs:
- fpm: see https://github.com/jordansissel/fpm
- rsync: this is usually installed on most *nix like systems
These two programs need to be installed before you can use the packaging scripts.
Configuration options marked as optional mean they can be left blank but they still must appear in the configuration array!
The name of your package. You should use only lowercase letters and dashes for the package name. Avoid non-ASCII characters.
The architecture name. Usually matches 'uname -m'. For automatic values, you can use 'all'
The version of your package.
Usually your name.
Example: Foo Bar <firstname.lastname@example.org>
The description of your package.
Example: Foo Drupal site
- url (optional)
The homepage of you package.
The type of package you're building. Choose deb or rpm.
- depends (optional)
An array containing a set of package names your package depends on.
Example: apache2, libapache2-mod-php, memcached, php5-memcached
The directory that will be used to build the package and to store the resulting package as well. You can use a directory outside of your project directory, like /tmp.
Example: tmp (this will put everything in a tmp directory inside your project directory)
The directory that holds files that must be templated. This must be relative to your project directory. Usually you then want to exclude this directory from the package (see 'filemapping' below).
Example: templates (that means all your template files are in the templates directory)
- postinst (optional)
The path to the postinst script in your project directory. The script will be incorporated into the package. To prevent the script from ending up alongside your source code on target system you shoud exclude it (see 'filemapping' below). The best way is to put it in the templatedir and exclude this directory.
- preinst (optional)
The path to the preinst script in your project directory. The script will be incorporated into the package. To prevent the script from ending up alongside your source code on target system you shoud exclude it (see 'filemapping' below). The best way is to put it in the templatedir and exclude this directory.
- postrm (optional)
The path to the postrm script in your project directory. The script will be incorporated into the package. To prevent the script from ending up alongside your source code on target system you shoud exclude it (see 'filemapping' below). The best way is to put it in the templatedir and exclude this directory.
- prerm (optional)
The path to the prerm script in your project directory. The script will be incorporated into the package. To prevent the script from ending up alongside your source code on target system you shoud exclude it (see 'filemapping' below). The best way is to put it in the templatedir and exclude this directory.
- debconfconfig (optional)
- Only for debian packages: The path (relative to the project root) to a debconf config file.
- debconftemplate (optional)
Only for debian packages: The path (relative to the project root) to a debconf template file.
For more information on debconf see http://www.debian.org/doc/packaging-manuals/debconf_specification.html
- configfile (optional)
Specify a file that is to be treated as a configuration file by the package manager. Configuration files are handled specially by the package manager. They will not be silently overwritten if an new package provides an updated version. Important: The path you specify here has to be the path to the location where the file will end up on the target system.
The filemapping variable should hold the mapping between your project files and their location on the server (ie. where they'll get installed). Each entry of this array is represented by the destination of the file (the key) and the file in your project (the value). The destination (the array keys) should always be in relative notation (ie. they must never begin with a slash).
The behaviour is different whether the value is an array or a single value. An array means that the destination is a directory and the contents of the array will be copied in this directory. If you just specify an empty array an empty directory is created. A string means that the destination is a file.
Note that you can use variables defined in your $configure array.
'var/www/@PACKAGENAME@' => array( 'app/', 'admin/', ), 'etc/cron.d/@PACKAGENAME' => 'templates/cron.template'
Additionally you can exclude specific files or even directories to prevent them from ending up in the package. To do this you need to prefix them with '- '.
'var/www/@PACKAGENAME@' => array( '*', '- /templates', ),
This will prevent the top level 'templates' directory in your source tree from ending up in the package.
RCS files (.git, .svn, .cvs) are already ignored in the Makefile so you don't need to exclude them here.
You can find more info on the syntax you can use in the paths in the rsync manpage, section FILTER RULES.
How does it work
- configure: its role is to create the Makefile
- template: its role is to replace placeholders in a file by actual configuration values
- Makefile.in: skeleton file of the final Makefile
- common.php: holds various functions used by the packaging/templating process
First, the configure script will take the values defined in the packaging_config.php file and use them to generate the Makefile, based on the Makefile.in file.
The resulting Makefile will be called when the user invokes the make command. The Makefile will do in order:
- Create the basic build structure in a temporary directory defined by the tmpdir configuration option
- Copy all the project files in this temporary directory, excluding all files that have been explicitly excluded, plus RCS and packaging files
- Template the files that are in the directory defined by the templatedir configuration option
- Create the directory structure as it will be on the server
- Copy each file to its directory structure as defined by the filemapping configuration option
- Call fpm on this final directory
If you want to change file permissions on the target system you can do that in the postinst script.
If for example you have a dedicated directory where your web application will write data this directory needs to be writeable by the webserver:
#!/bin/sh chown -R www-data:www-data /var/lib/sitedata/@PACKAGENAME@
Unfortunately it is not possible to setup a database interactively during the installation of the package. One workaround is to create a script that guides you through the configuration of a database and to put that script into the package (it could be put into '/usr/share/doc/@PACKAGENAME@/' for example). The person installing the package would then be responsible to run this script and adapt the application configuration.