This is a draft cheat sheet. It is a work in progress and is not finished yet.
Capistrano
:application |
application name |
:deploy_to |
deploy directory |
:domain |
domain name or ip |
:use_sudo |
use sudo to execute commands? |
:keep_releases |
number of releases to keep |
:role |
defines role of the server |
:log_level |
:debug log level |
Permissions
:writable_dirs (by the HTTP Server) |
[log_path, cache_path] |
:webserver_user |
"www-data" |
:permission_method (:chmod, :acl, or :chown) |
false |
:use_set_permissions |
false |
Folders and Files
:remote_tmp_dir |
"/tmp" |
:shared_files (Files that need to remain the same between deploys) |
false |
:shared_children Dirs that need to remain the same between deploys (shared dirs) |
[log_path, web_path + "/uploads"] |
:backup_path (Database backup folder) |
"backups" |
scm
|
:scm defines which scm to use (:git, :svn, etc)
|
|
:repository repository address
|
|
:deploy_via :remote_cache - git repository will be kept on the server and Capifony will only fetch the changes since the last deploy. :copy - clone the latest project version from the local git repo and copy to prod.
|
|
ssh_options[:forward_agent] if true, then local ssh keys will be used
|
|
:branch branch to use. default master
|
|
:scm_username he username that your Source Control system will use to access the repository.
|
|
:scm_password The password that your source control system (for ex: subversion) will use to access the repository. Not recommended
|
|
:local_repository
|
|
|
Symfony2
:app_path |
"app" |
application path |
:web_path |
"web" |
web path |
:symfony_console |
app_path + "/console" |
console bin |
:symfony_debug |
false |
debug flag for console commands |
:log_path |
app_path + "/logs" |
log path |
:cache_path |
app_path + "/cache" |
cache path |
:app_config_path |
app_path + "/config" |
config file path |
:clear_controllers |
true |
Need to clear *_dev controllers |
:controllers_to_clear |
['app_*.php'] |
controllers to clear |
Model Manager
|
:model_manager (doctrine, propel) "doctrine"
|
|
:doctrine_em false
|
|
:doctrine_clear_use_flush_option Use --flush option in doctrine:clear_* task false
|
Assets
|
:dump_assetic_assets false
|
|
:assets_install false
|
|
:assets_symlinks false
|
|
:assets_relative false
|
|
:assets_install_path web_path
|
:update_assets_version Whether to update assets_version
in config.yml
false
|
|
:asset_children Asset folders (that need to be timestamped) [web_path + "/css", web_path + "/images", web_path + "/js"]
|
Other
:interactive_mode |
true |
If set to false, it will never ask for confirmations (migrations task for instance) |
|
|
Vendors
|
:symfony_vendors "bin/vendors". bin vendors
|
|
:build_bootstrap "bin/build_bootstrap" build_bootstrap script
|
|
:use_composer false Whether to use composer to install vendors. If set to false, it will use the bin/vendors script
|
|
:use_composer_tmp false Whether to use composer to install vendors to a local temp directory
|
|
:composer_bin false Path to composer binary. If set to false, Capifony will download/install composer
|
|
:composer_options "--no-dev --verbose --prefer-dist --optimize-autoloader --no-progress" Options to pass to composer when installing/updating
|
|
:composer_dump_autoload_options "--optimize" Options to pass to composer when dumping the autoloader (dump-autoloader)
|
|
:update_vendors false Whether to update vendors using the configured dependency manager (composer or bin/vendors)
|
|
:vendors_mode "reinstall" run bin/vendors script in mode (upgrade, install (faster if shared /vendor folder) or reinstall)
|
|
:copy_vendors false Copy vendors from previous release
|
ssh
|
:user The SSH username you are logging into the server(s) as.
|
|
:password The SSH password you are logging into the server(s) with. Not recommended
|
|
:gateway Define a gateway server. All subsequent connections will be tunneled through the gateway (using SSH forwarded ports).
|
Multistage
:stages |
stages names: %w(dev prod) |
:default_stage |
default stage name |
:stage_dir |
directory with stages configs |
|
