Guide · Open source
How to use Deployer: install, deploy and recipes guide
Updated · written with AI from the project's own documentation and checked against our catalogue data
Deployer is an open-source deployment tool written in PHP that automates putting web applications onto servers. This guide explains what it does, what you need before starting, and how to clone it and get oriented. It is written for PHP developers who deploy their own applications and want a repeatable process instead of manual file copying.
Deployerdeployphp/deployer · ★ 11.1k · MIT Install options & downloads Quick start
- 1Check PHP is installed. Confirm PHP is available on your machine, since it is the stated prerequisite.
- 2Confirm git is available. Git is needed to clone the repository, as shown in the README.
- 3Clone the repository. Run git clone https://github.com/deployphp/deployer.git in the directory where you want the project.
- 4Read the documentation. Open deployer.org to learn configuration, recipes and the deployment process.
- 5Test on a non-production server. Try your deployment steps on a safe server before using them on production.
What Deployer does and who it is for
According to its README, Deployer offers automatic server provisioning, zero-downtime deployments, and ready-to-use recipes for most frameworks. People use it to replace manual copying of files and server setup steps with a process that runs the same way each time.
It suits PHP developers who deploy their own applications, teams that want the same deployment steps every time, and projects that need server provisioning as well as deployment.
- Automatic server provisioning
- Zero downtime deployments
- Ready to use recipes for most frameworks
What you need before you start
The README lists PHP as the prerequisite. Deployer is built around PHP, so it is not a fit for non-PHP projects. Setup and use also require comfort with the terminal and with servers, so beginners without that experience will find it hard going.
The README's install instruction is to clone the repository with git, so git must be available as well.
- PHP installed on your machine
- git, to clone the repository
- Terminal and basic server access
Clone the Deployer repository
The README gives one install command: cloning the source repository from GitHub. Run it in the directory where you want the project to live.
The README does not describe further installation steps, so check the documentation at deployer.org for how to set up and run Deployer after cloning.
git clone https://github.com/deployphp/deployer.gitFind the documentation and extra resources
The README points to deployer.org for more information and documentation, which is the place to learn how to configure deployments and use recipes.
The README also links a GitHub Action for Deployer and an official Deployer Docker image, which may be useful if you run deployments in continuous integration or containers.
- Documentation: deployer.org
- GitHub Action for Deployer (github.com/deployphp/action)
- Deployer Docker Image (hub.docker.com/r/deployphp/deployer)
Common pitfalls to avoid
Because Deployer changes files and configures servers, test your setup on a non-production server first. Keep your deployment steps in the project so the same process is repeated each time.
Remember the tool targets servers directly. If you only use a fully managed hosting platform and never touch servers, Deployer is probably not the right choice.
- Test on a non-production server before live use
- Keep the deployment process in version control
- Confirm your project is PHP before choosing Deployer
What people use it for
- Deploying a PHP web application to your own servers with the same steps each time
- Provisioning a server as part of the same process that deploys the application
- Using ready-made recipes for common PHP frameworks instead of writing deployment steps from scratch
- Running deployments from a continuous integration workflow, using the GitHub Action or Docker image linked in the README
Frequently asked questions
Is Deployer free to use?
Deployer is released under the MIT licence, according to its README and the licence badge. The MIT licence is a permissive open-source licence. Check the LICENSE file in the repository for the full terms.
What do I need to install Deployer?
The README lists PHP as the prerequisite. The install method given is cloning the repository with git. You also need comfort with the terminal and servers.
Can I use Deployer for non-PHP projects?
The README describes Deployer as a PHP tool, so it is built around PHP projects. For non-PHP projects, consider a tool like Ansible or Envoy, which are listed as comparable projects.
What is zero-downtime deployment?
The README lists zero downtime deployments as a feature, meaning Deployer is designed to deploy without taking the application offline. The README does not explain how this is achieved, so check deployer.org for details.
How does Deployer compare to Capistrano or Laravel Forge?
Capistrano, Envoy, Ansible and Laravel Forge are listed as comparable projects. Deployer's README highlights server provisioning, zero-downtime deployments and framework recipes. Compare the features you need against each project's documentation before choosing.
Is Deployer suitable for beginners?
Probably not for complete beginners. The tool requires terminal and server knowledge, so people without that background may find setup and use difficult.
New agent skills, repos and AI tools — every week
The best new skills and open-source projects, the fastest-growing repos, and one free prompt. Five minutes to read. Unsubscribe anytime.
Our verdict
Deployer is a good fit for PHP developers who deploy their own applications to servers and want a repeatable process with framework recipes and provisioning. It is a poor fit for non-PHP projects, for teams that only use fully managed hosting, or for people without command-line and server experience. Consider Capistrano, Envoy, Ansible or Laravel Forge if your needs differ.
Install options & downloads