WordPress Development: How to Use Bedrock and Trellis?

This is a post for all of you WordPress developers out there!

Today we’ll explain how to use and integrate Bedrock and Trellis at Kinsta.

If you haven’t heard of these two tools before, we’ll also introduce them and hopefully help to explain why you’d want to use them over a traditional setup.

Bedrock and Trellis

Both Bedrock and Trellis exist to make it easier to develop, maintain, and deploy WordPress sites.

Bedrock offers an alternative way to manage your WordPress installation with an improved folder structure, modern development tools, and improved security.
Trellis works with Bedrock to create development environments with Vagrant along with one-command deploys.

The main reason to use Bedrock is to get proper dependency and package management for a WordPress project. You may already be familiar with npm for JavaScript or Bundler for Ruby. PHP is no different, and its equivalent is Composer.

While using a package manager is common, it’s less common for WordPress itself since WordPress already has its own concept for plugins. Bedrock integrates Composer to manage plugins, themes, and even WordPress core itself as dependencies.

Trellis is a tool to easily create development and production servers to host WordPress sites. It’s specifically created to work with Bedrock-based sites as well. Trellis’ default use case is to use it to develop with Vagrant and in production as well to get parity between those two environments.

This post explains a slightly different use case: Trellis for your development server and Kinsta for your production (and/or staging) server.

Why use Kinsta over a Trellis provisioned VPS? Because sometimes you want to pay someone else to manage the server instead of doing it yourself (especially if you have a lot of clients). Kinsta also makes scaling easier without having to deal with multiple servers, load balancers, and cloud uploads.

A lot of WordPress hosts aren’t very developer-friendly and don’t offer SSH access and Composer or WP-CLI integration which are requirements to use Trellis and Bedrock. Thankfully, Kinsta offers SSH access on all of their hosting plans, from Starter to Enterprise, which makes all this possible. They can also modify the root path for proper functionality.

Bedrock vs Regular WordPress

You might be wondering why you would use Bedrock over a traditional WordPress install. The reason is that Bedrock is built specifically with the modern web developer in mind:

Environment-specific configuration files, stored outside of the public web root
Environment variables to separate config from code in a single .env file
Enhanced security by limiting access to non-web files along with bcrypt hashed passwords
Custom wp-content directory named app
Composer for managing WordPress, plugins, themes, and other PHP dependencies
.gitignore that excludes WordPress core, plugins, and uploads

Raspberry Pi, Snopes, JetBlue, and more, trust Bedrock to power their WordPress sites.

Let’s take a look at the two folder structures side-by-side:

Bedrock takes installing WordPress into a subdirectory to the next level. Much of the philosophy behind Bedrock is inspired by the Twelve-Factor App methodology including the WordPress specific version.

Configuring Trellis for Kinsta

First, make sure your public SSH keys are added to the MyKinsta dashboard.

Trellis can deploy to Kinsta with just a few updates. Since Kinsta provides everything from the web server standpoint, provisioning your staging and production environments do not apply.

The one-command deploys in Trellis work with Kinsta with a little configuration. Once configured, you’ll be able to deploy your WordPress sites by running the deploy playbook in Trellis:

ansible-playbook deploy.yml -e env=staging -e site=example.com --limit=kinsta_staging

Bring up your MyKinsta dashboard and navigate to the WordPress site that you’re setting up with Bedrock and Trellis, along with your code editor opened to the trellis directory in your project.

First edit trellis/ansible.cfg to add the following to [defaults] at the top:

forks = 3
host_key_checking = False

Staging Configuration

Make sure that trellis/group_vars/staging/wordpress_sites.yml is configured with the proper canonical for your staging site:

wordpress_sites:
  example.com:
    site_hosts:
      - canonical: staging-example.kinsta.com

Then open up trellis/group_vars/staging/main.yml and add the following to the end of the file:

project_root: /www/example_123/public
www_root: /www/example_123/public
web_user: example
web_group: www-data

Replace the project_root and www_root paths with the correct path provided in the MyKinsta dashboard for your Kinsta staging environment.

Next, open trellis/group_vars/staging/vault.yml for editing by running ansible-vault edit group_vars/staging/vault.yml.

We need to add db_user, db_name, and db_password to env. You can find the values for these on the main info screen for your site in the MyKinsta dashboard.

SFTP and database credentials in MyKinsta.

vault_wordpress_sites:
  example.com:
    env:
      db_user: "example"
      db_name: "example"
      db_password: "xxxxxxxxxxxxxxx"
      # Generate your keys here: https://roots.io/salts.html
      auth_key: ""
      secure_auth_key: ""
      logged_in_key: ""
      nonce_key: ""
      auth_salt: ""
      secure_auth_salt: ""
      logged_in_salt: ""
      nonce_salt: ""

Finally, open trellis/hosts/staging and replace the contents with:

kinsta_staging ansible_host=104.154.94.123 ansible_ssh_port=12345 ansible_ssh_extra_args='-o StrictHostKeyChecking=no'

[web]
kinsta_staging

[staging]
kinsta_staging

Make sure that the host and SSH port match what is listed in the MyKinsta dashboard.

SFTP host and port details for your staging environment.

Info

In some cases, especially with non-standard WordPress setups like Bedrock, Kinsta might not automatically detect your database credentials. This can lead to issues when performing operations such as cloning environments, restoring backups, or updating database passwords.

To avoid this, you need to manually define specific PHP constants in your Bedrock site’s configuration file (bedrock/config/application.php). This step is essential to ensure that Kinsta can correctly manage your site’s database credentials.

Here’s how you can define the necessary constants:

define('DB_NAME', defined('SERVER_SECRET_DB_NAME') ? SERVER_SECRET_DB_NAME : 'your_db_name');
define('DB_USER', defined('SERVER_SECRET_DB_USER') ? SERVER_SECRET_DB_USER : 'your_db_user');
define('DB_PASSWORD', defined('SERVER_SECRET_DB_PASSWORD') ? SERVER_SECRET_DB_PASSWORD : 'your_db_password');
define('DB_HOST', defined('SERVER_SECRET_DB_HOST') ? SERVER_SECRET_DB_HOST : 'localhost');

By adding these lines to your configuration file, you ensure that MyKinsta can properly manage your database credentials, which is crucial for maintaining a smooth and error-free deployment process.

Production Configuration

Now, let’s repeat the same process above for the production environment. Make sure to toggle to your “live” environment in the MyKinsta dashboard.

Switch to your live environment in MyKinsta.

Open up trellis/group_vars/production/main.yml and add the following to the end of the file:

project_root: /www/example_123/public
www_root: /www/example_123/public
web_user: example
web_group: www-data

Be sure to replace the project_root and www_root paths with the correct path provided in the MyKinsta dashboard for your live environment.

Next, open trellis/group_vars/production/vault.yml for editing by running ansible-vault edit group_vars/production/vault.yml:

vault_wordpress_sites:
  example.com:
    env:
      db_user: "example"
      db_name: "example"
      db_password: "xxxxxxxxxxxxxxx"
      # Generate your keys here: https://roots.io/salts.html
      auth_key: ""
      secure_auth_key: ""
      logged_in_key: ""
      nonce_key: ""
      auth_salt: ""
      secure_auth_salt: ""
      logged_in_salt: ""
      nonce_salt: ""

Finally, open trellis/hosts/production and replace the contents with:

kinsta_production ansible_host=104.154.94.123 ansible_ssh_port=12345 ansible_ssh_extra_args='-o StrictHostKeyChecking=no'

[web]
kinsta_production

[production]
kinsta_production

Modifying the Deploy Tasks

Trellis deploys try to reload php-fpm, which we need to remove from attempting to run on Kinsta’s servers. We also need to trigger the clearing of Kinsta’s cache on a deploy.

Open trellis/roles/deploy/hooks/finalize-after.yml and scroll to the bottom. Remove the last task for Reload php-fpmand add the following:

- name: Clear Kinsta cache
  uri:
    url: "{{ site_env.wp_home }}/ask-support-rep/"
    method: GET

Replace ask-support-rep above after asking a Kinsta support rep for the URL to clearing the cache on your site.

Optional: Install Composer Dependencies

If you’re getting a screen that tells you to run ‘Composer Install,’ add the following right before the “Clear Kinsta cache” code above:

- name: Install Composer dependencies
composer:
command: install
working_dir: >/www/example123/public/final-path

The /final-path might vary based on your Bedrock/Trellis settings.

Adding kinsta-mu-plugins to Bedrock

Bedrock sites come with mu-plugins installed automatically, but, you’ll need to install the Kinsta MU plugin by bringing in the kinsta-mu-plugins package. This plugin (which is installed by default when you create a WordPress site through MyKinsta) handles things such as full page caching and the Kinsta CDN integration.

Open site/composer.json and add the following within the repositories array:

{
  "type": "package",
  "package": {
    "name": "kinsta/kinsta-mu-plugins",
    "type": "wordpress-muplugin",
    "version": "2.3.3",
    "dist": {
      "url": "https://kinsta.com/kinsta-tools/kinsta-mu-plugins.zip",
      "type": "zip"
    }
  }
}

Then run the following from your Bedrock/site directory (or specify kinsta/kinsta-mu plugins as a requirement in your composer.json file:

composer require kinsta/kinsta-mu-plugins:2.3.3

The following constants may be required to fix issues with CDN paths and shared plugin asset URLs. Add the following code to your site’s configuration file (bedrock/config/application.php in Bedrock sites):

/**
 * Kinsta CDN fix for Bedrock
 */
define('KINSTA_CDN_USERDIRS', 'app');

/**
 * Fix Kinsta MU Plugins URL path with Bedrock
 */
$mu_plugins_url = Config::get('WP_CONTENT_URL') . '/mu-plugins';
define('KINSTAMU_CUSTOM_MUPLUGIN_URL', "{$mu_plugins_url}/kinsta-mu-plugins");

For more information, including how to update the plugin, check out our guide for the Kinsta MU plugin.

Final Steps With Kinsta Support

The last thing you need to do is inform Kinsta of what to set the document root to. Hop on MyKinsta and ask the support team for your document root be updated to public/current/web.

If you didn’t already get the clear cache URL earlier, also ask your support rep for this, and make sure that trellis/roles/deploy/hooks/finalize-after.yml is updated with the correct URL to clear Kinsta’s cache on a successful deploy.

Once this change has been made you’ll be able to deploy to both your staging and production environments with a single line:

# Deploy staging
ansible-playbook deploy.yml -e env=staging -e site=example.com --limit=kinsta_staging

# Deploy production
ansible-playbook deploy.yml -e env=production -e site=example.com --limit=kinsta_production

Better yet… setup a continuous integration service, such as CircleCI, to automatically run the deploy for you when you commit to either staging or master!

Ben Word

Ben Word is a web developer and interaction designer. He is the founder of Roots, an open-source organization that creates tools to help WordPress developers build better sites.

Neil Gilmour April 11, 2018 at 4:30 am

Awesome! Another great write up from Ben Word, and so good to see Kinsta supporting Roots. Thanks both :)

Brian Jackson April 11, 2018 at 10:03 am


Thanks Neil! We are excited to support awesome projects like Roots :)

Evan April 12, 2018 at 7:48 am

Hey Ben, when I last looked at hosting with Kinsta, I recall the ability to not be able to programmatically reload PHP-FPM to be a problem. Does this workflow allow for zero downtime deploys and symlinked releases?

Brian Jackson May 20, 2018 at 10:17 pm


Hey Evan! As Ben mentioned above in the post, at this time you’ll need to remove that as part of the deployment task as it’s not currently possible to reload PHP-FPM programmatically. Thanks

Sandro Würmli September 14, 2018 at 12:07 pm

Can someone tell me which editor / theme / plugins are used in the Bedrock vs. WordPress Screenshot?

Ben Word November 9, 2018 at 7:27 am


It’s VS Code, no plugins should be needed :) I’ve since switched themes and don’t recall which one I was using in the screenshot

Gerard November 8, 2018 at 5:40 pm

It’s worth noting that the composer installation of the kinsta-mu-plugins above will put the plugin in the wrong folder. After going through those steps, the plugin ended up nested one folder too deep inside my app/mu-plugins folder. I contacted support and they just manually moved it to the correct spot.

Amar March 8, 2019 at 5:57 pm

Is there any workaround to make staging deployment to live work with Trellis/Bedrock? When the deployment happens in Kinsta, it overwrites the .env file in production with the one in staging, thus the production site is redirected to the staging site because it’s using the url of the staging site. The only thing I can currently do is re-run Trellis deployment after doing a deployment in Kinsta.

Ben Word March 11, 2019 at 1:52 pm


Hi Amar,

This shouldn’t be happening if everything is configured the same as this guide – can you double-check everything, especially the hosts files in Trellis?

Jan August 14, 2019 at 1:59 am

The following worked for me instead of the posted Composer hook for after deploy.

– name: Install Composer dependencies – Kinsta fix
composer:
command: install
working_dir: /www/[name]/public/current

Hannah June 25, 2021 at 4:13 pm

Wow, really appreciate the clarification for updating the Kinsta CDN path.

“Within `/config/application.php`:

`define( ‘KINSTA_CDN_USERDIRS’, ‘app’);`”

Rob Record March 28, 2022 at 2:33 pm

Hi Ben,

I think there may be an error in this part:

“Optional: Install Composer Dependencies”

The working_dir should not have the triangle bracket at the beginning.

Further, shouldn’t this value be put into another file and drawn in at runtime?

ALSO for anyone wanting to know, the URL to flush the cache is “{{ site_env.wp_home }}/kinsta-clear-cache-all/”

Rob Record March 28, 2022 at 2:34 pm

Also the indentation in the part “Optional: Install Composer Dependencies” seems askew, I had to correct it.

Ben Word March 30, 2022 at 3:29 am

Thanks Rob! I’m not sure where that addition of the guide came from or why it’s necessary. I do not use that personally.

And FYI, that flush cache URL was purposely not made public

Powerful Managed WordPress Hosting

WordPress highlights

Platform highlights

We power your

Case studies

Yoko Co supports high-traffic NGO sites with up to 75% faster WP hosting

5Tales drives up to 152% more traffic and 2,914% higher visibility for 100+ client sites

Resources

Contact us

WordPress Development: How to Use Bedrock and Trellis?

Bedrock and Trellis

Bedrock vs Regular WordPress

Configuring Trellis for Kinsta

Staging Configuration

Production Configuration

Modifying the Deploy Tasks

Optional: Install Composer Dependencies

Adding kinsta-mu-plugins to Bedrock

Final Steps With Kinsta Support

Comments

Leave a Reply Cancel reply

Powerful Managed WordPress Hosting

Yoko Co supports high-traffic NGO sites with up to 75% faster WP hosting

5Tales drives up to 152% more traffic and 2,914% higher visibility for 100+ client sites

WordPress Development: How to Use Bedrock and Trellis?

Bedrock and Trellis

Bedrock vs Regular WordPress

Configuring Trellis for Kinsta

Staging Configuration

Production Configuration

Modifying the Deploy Tasks

Optional: Install Composer Dependencies

Adding kinsta-mu-plugins to Bedrock

Final Steps With Kinsta Support

Related Articles and Topics

Powerful Managed WordPress Hosting

Debugging WordPress Performance Issues: “Stuff Happens” Checklist

Comments

Leave a Reply Cancel reply