via on an environment. Options live under options.
A server using
ssh needs a one-time setup. See SSH server setup.
Platforms that deploy from a URL or a command do not need a dedicated deployer. See Recipes.Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
Choose how an environment ships the tested artifact: SSH releases, Laravel Cloud, Forge, Vapor, Envoyer, a webhook, or your own commands.
via on an environment. Options live under options.
| Deployer | What it does | Options |
|---|---|---|
ssh | Zero-downtime release over SSH: rsync a new releases/<timestamp>, share .env and storage, atomically switch the current symlink, prune old releases. Host keys are verified (StrictHostKeyChecking=yes). | host, user, path, port, keep_releases, migrate, optimize, storage_link, post_deploy, key_secret, known_hosts_secret |
vapor | vendor/bin/vapor deploy | secret, environment |
forge | Calls the Forge deployment trigger URL | secret |
cloud | Calls the Laravel Cloud deploy hook for the commit that passed CI | secret, commit |
envoyer | Calls the Envoyer deployment hook | secret |
webhook | POST to your own endpoint | secret, rollback_secret |
command | Your own shell commands | commands, rollback_commands, secrets, tools, php, artifact |
ssh needs a one-time setup. See SSH server setup.