Pomander

All Pomander settings are exposed through the $env object.


$env->url('http://ripeworks.com');
$env->url // http://ripeworks.com

$env->super_secret_setting(true);
$env->super_secret_setting // true

You can set and retrieve any known option or even define your own.

Deploy Settings

$env->deploy_to('/var/www/html/my_application');
Specify where your application will be deployed to.
$env->app('my-app.com'); $env->app(array('node-1.my-app.com','node-2.my-app.com'));
String or Array of application hosts to deploy to.
$env->repository('');
Location of the repository used for deploying.
$env->revision(); $env->branch();
Specify which branch/commit to deploy.
$env->scm('git');
SCM to use. Git and Svn are currently supported. Defaults to git
$env->releases(true);
Use current/releases/shared structure. (true/false/number of releases to keep) Default: false
$env->remote_cache(true);
Cache repository for faster deploys. (true/false) Default: true when releases are set

$env->user('deploy');
Specify which user to connect as. Default: user running pom
$env->port(22);
Which port to use when connecting to target. Default: 22
$env->password();
Password used when connecting to target.
$env->key_path("~/.ssh/id_rsa"); $env->key_password();
Specify path to deploy key (private), and optionally password to authenticate key. Default: ~/.ssh/id_rsa (Only supports RSA keys currently)

$env->adapter('mysql');
Which type of database you are using. MySQL is currently supported.
$env->backup(true);
Create a full database backup before any merge commands.
$env->db();
String or Array of database hosts to deploy to.

$env->umask('002');
Which umask to use on remote hosts.
$env->rsync_cmd('rsync');
Command used to sync files and folders. Default is rsync.
$env->rsync_flags('-avuzPO --quiet');
Flags used to sync files and folders. Defaults to the above.
$env->db_backup_flags("--lock-tables=FALSE --skip-add-drop-table | sed -e 's|INSERT INTO|REPLACE INTO|' -e 's|CREATE TABLE|CREATE TABLE IF NOT EXISTS|'");
Additional flags used when creating a database backup used for merging. By default backups will skip drop tables and use replace into as to not destroy existing data during a merge. This is useful if you are staging new data that isn't in production.
$env->db_swap_url(true);
If you are merging a database backup and the $env->url of the two environments differ, Pomander will attempt to replace all occurances of the urls. Set this option to false to prevent Pomander from doing that.

If there are any settings in need that are preventing you from using Pomander, please submit an Issue.