PHPackages longman/ansistrano - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [DevOps & Deployment](/categories/devops) 4. / 5. longman/ansistrano ActiveLibrary[DevOps & Deployment](/categories/devops) longman/ansistrano ================== Ansistrano configuration skeleton 3.4.0(5mo ago)14.4k↑34.4%MIT Since Nov 8Pushed 5mo ago1 watchersCompare [ Source](https://github.com/akalongman/ansistrano)[ Packagist](https://packagist.org/packages/longman/ansistrano)[ Docs](https://github.com/akalongman/ansistrano)[ RSS](/packages/longman-ansistrano/feed)WikiDiscussions master Synced 2d ago READMEChangelogDependenciesVersions (59)Used By (0) Ansistrano Wrapper ================== [](#ansistrano-wrapper) A configuration skeleton around the community [`ansistrano.deploy`](https://ansistrano.com/)and `ansistrano.rollback` Ansible Galaxy roles. Those roles provide Capistrano style, zero-downtime, release-based deployment: each deploy lands in its own `releases//` directory, then a `current` symlink is atomically flipped to point at it. Rolling back is just moving that symlink to the previous release. This wrapper adds no deployment engine of its own. Its job is to inject PHP and Laravel specific steps (cache warming, opcache reset, php-fpm reload, queue, Horizon, Reverb, Supervisor, cron, Slack notifications, and more) into Ansistrano's lifecycle hooks, each one toggled per server group by a simple variable. Requirements ------------ [](#requirements) - Ansible on the control machine (the machine that runs the deploy). - The two Galaxy roles listed in `requirements.yml` (`ansistrano.deploy` 3.14.0, `ansistrano.rollback` 3.1.0). - SSH access from the control machine to your target servers. Installation ------------ [](#installation) Install this package into your PHP project as a dev dependency, then install the Galaxy roles. ``` composer require --dev longman/ansistrano ansible-galaxy install -r vendor/longman/ansistrano/requirements.yml ``` The package expects to live at `vendor/longman/ansistrano/` inside your project. That placement matters: `vars/defaults.yml` sets `ansistrano_deploy_from` to `{{ playbook_dir }}/../../..`, which walks three levels up from the package to your project root. The project root is what gets rsynced to the servers. What your project must provide ------------------------------ [](#what-your-project-must-provide) The playbooks reference files that live in the consuming project, not in this package. Create these before your first deploy. Path (relative to your project root)Purpose`build/ansible/vars.yml`Your project's own Ansible variables, loaded via `app_vars_file`.`build/ansible/hosts.ini`Your inventory (copy and adapt `example/hosts.ini`).`build/.rsync_excludes`Paths excluded from the rsync (referenced through `ansistrano_rsync_extra_params`).`build/deploy/nginx/.conf.j2`nginx vhost template, used only by dynamic deployments.`build/deploy/supervisor/.conf.j2`Supervisor program template (Horizon and Reverb variants use `-horizon.conf.j2` and `-reverb.conf.j2`).See `example/vars.yml` and `example/hosts.ini` for starting points. Configuration ------------- [](#configuration) Configuration flows through two variable namespaces. - `ansistrano_*` variables are consumed by the upstream role. They control the release mechanics (`ansistrano_deploy_to`, `ansistrano_keep_releases`, `ansistrano_shared_paths`, `ansistrano_deploy_via`, and the hook file bindings). Sensible defaults live in `vars/defaults.yml`. - `app_*` variables are this wrapper's own convention. They fall into two groups: core settings that every deploy needs, and boolean feature toggles that turn individual post-deploy steps on or off. ### Core variables [](#core-variables) Set these in your inventory (see `example/hosts.ini`) or in `build/ansible/vars.yml`. VariableMeaning`app_deploy_to`Absolute target path on the server (for example `/var/www/project.com`). Maps to `ansistrano_deploy_to`.`app_project_name`Human readable project name, used in task and notification titles.`app_environment`Environment name (`staging`, `production`, ...). Selects template variants.`app_vars_file`Path to your project vars file, relative to project root (for example `build/ansible/vars.yml`).`app_writeable_paths`List of paths made writeable when `app_set_writeable_permissions` is on.`app_deployer_user`, `app_deployer_group`Ownership applied to created files and directories. Default to `ansible_user`.`app_slack_token`, `app_slack_channel`Slack credentials. A defined, non-empty token enables notifications.### Feature toggles [](#feature-toggles) Each optional step is gated by a variable. Boolean toggles use `app_foo|bool == true`; a few are presence based, meaning the step runs when the variable is simply defined. Set toggles per server group in your inventory's `[group:vars]`sections so each role (web, backend, task) runs only what it needs. Steps run before the `current` symlink is flipped (they operate on the new release being built): ToggleTypeWhat it does`app_sync_storage_folder`boolSyncs the local `storage/` into the server's `shared/` before code update.`app_set_writeable_permissions`bool`chmod -R 777` on each path in `app_writeable_paths`. Escalates only if `app_become_on_set_permissions` is true.`app_symlink_storage_public`boolSymlinks `storage/app/public` to `public/storage` in the new release.`app_doctrine_prepare`boolGenerates Doctrine proxies and clears the metadata cache.`app_generate_passport_keys`boolRuns `passport:keys` (errors ignored).`app_optimize_pre`boolWarms `config:cache`, `route:cache`, and `event:cache`. Override the routes command with `app_cmd_cache_routes`.`app_run_self_diagnosis`boolRuns `php artisan self-diagnosis `.`app_doctrine_update`boolRuns `doctrine:schema:update --force`.Steps run after the symlink flip (they operate on the live `current` release): ToggleTypeWhat it does`app_restart_pm2`boolRestarts a PM2 process named by `app_pm2_script_name`.`app_reset_opcache`boolResets opcache via `cachetool`. Variant is chosen by presence of `app_fcgi_connection` or `app_cachetool_config`, otherwise CLI.`app_restart_phpfpm`boolReloads php-fpm through systemctl.`app_optimize_post`boolWarms `view:cache`.`app_deploy_supervisor_horizon_config`boolRenders and installs the Horizon Supervisor config.`app_deploy_supervisor_reverb_config`boolRenders and installs the Reverb Supervisor config.`app_restart_supervisor`boolRestarts the Supervisor service (name via `app_supervisor_service_name`, default `supervisord`).`app_restart_queue`boolRuns `queue:restart`.`app_restart_horizon`boolRuns `horizon:terminate` so Horizon respawns on the new release.`app_add_cron_entry`boolInstalls a per-minute `schedule:run` cron entry.Supervisor config filenames default to the RHEL layout (`/etc/supervisord.d/.ini`). For the Debian/Ubuntu layout, override both the directory and the extension, for example `app_supervisor_config_dest: /etc/supervisor/conf.d` and `app_supervisor_config_ext: conf`. The same two variables also drive the Horizon and Reverb config filenames and the dynamic cleanup that removes them. The presence of a non-empty `app_slack_token` enables a success notification at the end of a deploy and a failure notification if any task fails. Usage ----- [](#usage) Run the playbooks from your project root, pointing `-i` at your inventory and naming the playbook inside the package. ``` # Deploy ansible-playbook -i build/ansible/hosts.ini vendor/longman/ansistrano/deploy.yml # Roll back one release ansible-playbook -i build/ansible/hosts.ini vendor/longman/ansistrano/rollback.yml # Tear down a dynamic deployment ansible-playbook -i build/ansible/hosts.ini vendor/longman/ansistrano/cleanup.yml ``` `deploy.yml` and `cleanup.yml` set `any_errors_fatal: true`, so a failure on any host aborts the whole run. Useful selectors while iterating: ``` ansible-playbook ... deploy.yml --syntax-check # parse only ansible-playbook ... deploy.yml --check # dry run ansible-playbook ... deploy.yml --limit task # one inventory group ansible-playbook ... deploy.yml --tags pre # one lifecycle phase ansible-playbook ... deploy.yml --start-at-task "APP | Restart Horizon" ``` Tasks are tagged on two axes: lifecycle phase (`pre`, `post`) and concern (`app`, `server`, `dynamic`). Combine with `--tags` to run a subset. Deployment lifecycle -------------------- [](#deployment-lifecycle) Ansistrano exposes hook points around its run. This wrapper binds a dispatcher file to each one in `vars/defaults.yml`. Every dispatcher is a list of conditional includes, so a step only runs when its toggle is set. Hook (`config/`)When it runsTypical work`before_setup.yml`before the release directory existsDynamic infrastructure (DNS, folders, mounts, nginx).`before_update_code.yml`before code is syncedSync storage content.`before_symlink.yml`new release built, not yet livePermissions, cache warm, self-diagnosis, Doctrine.`after_symlink.yml`new release is now liveopcache reset, service restarts, cron, Slack.`after_cleanup.yml`after old releases are prunedCopyright notice.`on_failure.yml`any task failsSlack failure notification.Dynamic deployments ------------------- [](#dynamic-deployments) Setting `app_dynamic_deploy` to true enables an ephemeral, per-domain deployment mode. On deploy it provisions a Route53 DNS record, the folder structure, NFS storage mounts, and an nginx vhost for `app_domain`. Each provisioning step has a teardown counterpart, all wired through `cleanup.yml`, so running the cleanup playbook removes everything the deploy created. The nginx vhost is further gated by `app_dynamic_create_vhost`, and the storage mount by the presence of `app_dynamic_mount_path`. These tasks run with privilege escalation and require AWS credentials (`app_aws_access_key_id`, `app_aws_secret_access_key`) for the DNS step. Notes ----- [](#notes) - Two task files ship but are not wired into any hook: `composer_optimize.yml` and `symlink_uploads.yml`. Include them yourself if you need them. - `create_supervisor_config.yml` and `restart_supervisor_instance.yml` are deprecated. Prefer the Laravel specific Supervisor tasks under `config/tasks/laravel/`. - `restart_phpfpm.yml` reloads a hardcoded `php74-php-fpm` unit. Adjust it for your PHP version. - The automatic rollback on failure is present but commented out in `on_failure.yml`. License ------- [](#license) Released under the MIT License. See `LICENSE`. Maintained by Avtandil Kikabidze (). ### Health Score 48 — FairBetter than 93% of packages Maintenance72 Regular maintenance activity Popularity23 Limited adoption so far Community9 Small or concentrated contributor base Maturity72 Established project with proven stability Bus Factor1 Top contributor holds 98.4% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~40 days Recently: every ~88 days Total 58 Last Release 157d ago Major Versions 1.3.0 → 2.0.02024-08-05 2.1.7 → 3.0.02025-02-02 ### Community Maintainers ![](https://www.gravatar.com/avatar/ce7f33760f36c96e98898e3c61da6d9be21cbccc37cf628005d6076d09a7720d?d=identicon)[LONGMAN](/maintainers/LONGMAN) --- Top Contributors [![akalongman](https://avatars.githubusercontent.com/u/423050?v=4)](https://github.com/akalongman "akalongman (63 commits)")[![kotso](https://avatars.githubusercontent.com/u/1928528?v=4)](https://github.com/kotso "kotso (1 commits)") --- Tags ansistranodeployrollbackdeployrollbackansistrano ### Embed Badge ![Health badge](/badges/longman-ansistrano/health.svg) ``` [![Health](https://phpackages.com/badges/longman-ansistrano/health.svg)](https://phpackages.com/packages/longman-ansistrano) ``` ### Alternatives [banago/phploy PHPloy - Incremental Git (S)FTP deployment tool that supports submodules, multiple servers and rollbacks. 1.4k48.0k](/packages/banago-phploy)[easycorp/easy-deploy-bundle The easiest way to deploy Symfony applications 469313.4k](/packages/easycorp-easy-deploy-bundle)[jalogut/magento2-deployer-plus Magento 2 deployment tool based on deployer.org 201444.0k](/packages/jalogut-magento2-deployer-plus)[pomander/pomander Deployment for PHP 19615.7k2](/packages/pomander-pomander)[hpatoio/deploy-bundle Easy deploy via rsync. Porting of Symfony 1 project:deploy command. 3397.5k1](/packages/hpatoio-deploy-bundle)[rafaelstz/deployer-magento2 Magento 2 deployment tool based on deployer.org 5224.0k](/packages/rafaelstz-deployer-magento2) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)