Need help with trellis?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

roots
2.2K Stars 568 Forks MIT License 1.6K Commits 54 Opened issues

Description

Ansible playbooks for a WordPress LEMP stack

Services available

!
?

Need anything else?

Contributors list

Trellis

MIT License Release Build Status Follow Roots

Ansible-powered LEMP stack for WordPress
Built with ❤️

Official Website | Documentation | Change Log

Supporting

Trellis is an open source project and completely free to use.

However, the amount of effort needed to maintain and develop new features and products within the Roots ecosystem is not sustainable without proper financial backing. If you have the capability, please consider donating using the links below:

Donate via Patreon Donate via PayPal

Overview

Ansible playbooks for setting up a LEMP stack for WordPress.

  • Local development environment with Vagrant
  • High-performance production servers
  • Zero-downtime deploys for your Bedrock-based WordPress sites
  • trellis-cli for easier management

What's included

Trellis will configure a server with the following and more:

  • Ubuntu 20.04 Focal LTS
  • Nginx (with optional FastCGI micro-caching)
  • PHP 7.4
  • MariaDB (a drop-in MySQL replacement)
  • SSL support (scores an A+ on the Qualys SSL Labs Test)
  • Let's Encrypt for free SSL certificates
  • HTTP/2 support (requires SSL)
  • Composer
  • WP-CLI
  • sSMTP (mail delivery)
  • MailHog
  • Memcached
  • Fail2ban and ferm

Documentation

Full documentation is available at https://roots.io/docs/trellis/master/installation/.

Requirements

Make sure all dependencies have been installed before moving on:

Windows user? Read the Windows getting started docs for slightly different installation instructions.

Installation

Using trellis-cli

Create a new project:

$ trellis new example.com

Manual

The recommended directory structure for a Trellis project looks like:

example.com/      # → Root folder for the project
├── trellis/      # → Your clone of this repository
└── site/         # → A Bedrock-based WordPress site
    └── web/
        ├── app/  # → WordPress content directory (themes, plugins, etc.)
        └── wp/   # → WordPress core (don't touch!)

See a complete working example in the roots-example-project.com repo.

  1. Create a new project directory:
$ mkdir example.com && cd example.com
  1. Install Trellis:
$ git clone --depth=1 [email protected]:roots/trellis.git && rm -rf trellis/.git
  1. Install Bedrock into the
    site
    directory:
$ composer create-project roots/bedrock site

Local development setup

Using trellis-cli

  1. Review the automatically created site in
    group_vars/development/wordpress_sites.yml
  2. Customize settings if necessary

Start the Vagrant virtual machine:

$ trellis up

Manual

  1. Configure your WordPress sites in
    group_vars/development/wordpress_sites.yml
    and in
    group_vars/development/vault.yml
  2. Ensure you're in the trellis directory:
    cd trellis
  3. Run
    vagrant up

Read the local development docs for more information.

Remote server setup (staging/production)

A base Ubuntu 18.04 (Bionic) or Ubuntu 20.04 (Focal LTS) server is required for setting up remote servers.

  1. Configure your WordPress sites in
    group_vars//wordpress_sites.yml
    and in
    group_vars//vault.yml
    (see the Vault docs for how to encrypt files containing passwords)
  2. Add your server IP/hostnames to
    hosts/
  3. Specify public SSH keys for
    users
    in
    group_vars/all/users.yml
    (see the SSH Keys docs)

Using trellis-cli

Initialize Trellis (Virtualenv) environment:

$ trellis init

Provision the server:

$ trellis provision production

Or take advantage of its Digital Ocean support to create a Droplet and provision it in a single command:

$ trellis droplet create production

Manual

For remote servers, installing Ansible locally is an additional requirement. See the docs for more information.

Provision the server:

$ ansible-playbook server.yml -e env=

Read the remote server docs for more information.

Deploying to remote servers

  1. Add the
    repo
    (Git URL) of your Bedrock WordPress project in the corresponding
    group_vars//wordpress_sites.yml
    file
  2. Set the
    branch
    you want to deploy (defaults to
    master
    )

Using trellis-cli

Deploy a site:

$ trellis deploy  

Rollback a deploy:

$ trellis rollback  

Manual

Deploy a site:

$ ./bin/deploy.sh  

Rollback a deploy:

$ ansible-playbook rollback.yml -e "site= env="

Read the deploys docs for more information.

Contributing

Contributions are welcome from everyone. We have contributing guidelines to help you get started.

Trellis sponsors

Help support our open-source development efforts by becoming a patron.

Kinsta KM Digital Carrot C21 Redwood Realty WordPress.com Motto

Community

Keep track of development and community news.

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.