Trellis integrates with Vagrant to automatically run the Ansible provisioner via the default
Vagrantfile. Provisioning in development uses the
dev.yml Ansible playbook to create a Vagrant virtual machine running your WordPress site.
Follow these steps to get a development server running:
- Configure your site(s) based on the WordPress Sites docs and read the development specific ones.
- Make sure you've edited both
- Optionally configure the IP address at the top of the
vagrant.default.ymlto allow for multiple boxes to be run concurrently (default is
trellis upfrom anywhere in your project (or
vagrant upfrom your trellis directory, usually the
trellis/subdirectory of your project).
trellis up will fail if you are using encrypted folders/hard drives
Then let Vagrant and Ansible do their thing. After roughly 5-10 minutes you'll have a virtual machine running and a WordPress site automatically installed and configured.
To access the VM, run
trellis ssh development (or
vagrant ssh from your
trellis directory). Sites can be found at
/srv/www/<site name> on the Ubuntu VM. See the Vagrant docs for more commands.
Note that each WP site you configured is synced between your local machine (the host) and the Vagrant VM. Any changes made to your host will be synced instantly to the VM. There's no need to manually sync files or deploy to the VM.
Composer and WP-CLI commands need to be run on the virtual machine for any post-provision modifications. Front-end build tools should be run from your host machine and not the Vagrant VM.
Trellis installs WordPress on your first
vagrant up with
admin as the default user. You can override this by defining
admin_user, as noted in the WordPress sites options.
Re-provisioning is always assumed to be a safe operation. When you make changes to your Trellis configuration, you should provision the VM again to apply the changes:
Run the following from your project's
You can also provision with specific tags to only run the relevant roles:
Run the following from your project's
If you added a new WordPress site (or manually added new synced directories to Vagrant), you'll need to reload the VM as well:
See the Vagrant page for more Vagrant specific configuration details.
Other non-Vagrant options
While Trellis offers integrated Vagrant development environments, it is completely optional. There are other local development options as well. Most of these options mean you're using Trellis for your production servers but something else entirely in development which is why it's not recommended.
Valet can be used in development if you're already using it for Laravel projects or want a lighter-weight solution than a full virtual machine.
However, be warned that doesn't guarantee development and production parity. Using Valet locally means you aren't using Trellis at all in development.
trellis-cli does offer some basic Valet integration as well. Run
for more information.
Manual virtual machines
If you use another tool to create and run virtual machines, Trellis can be configured to provision them as well. For this use case, you'll need to follow the remote server setup documentation since provisioning a remote server is mostly the same as provisioning a virtual machine.
There's a few things you'll probably want to manually replicate with the Vagrant integration:
- networking and hosts file management: you'll need some way to access the guest
IP of your virtual machine. This might involve manually editing your
/etc/hostsfile to ensure that the domain is mapped to that IP.
- synced folders: the root directory of your site/Trellis project will need to be shared/synced to your virtual machine so the files are accessible.
If you don't (or can't) sync the local folders, then your setup will be
identical to the remote server setup. You'll run the
server.yml playbook and
If you do sync local folders, you can use the
dev.yml development playbook
which assumes your site is available on the guest VM and runs the WordPress
installation process automatically.
That's right... nothing! You might not care about a local development environment. Or you might only want to use Trellis for deploying to managed servers like. Trellis is quite flexible and supports these uses cases as well.
Help us continue to build and maintain our open source projects. We’re a small team of independent developers and every little bit helps.Sponsor Roots on GitHub