Skip to content

Commit

Permalink
Merge pull request #311 from roots/readme-usage
Browse files Browse the repository at this point in the history
Readme Sentence Structure and Usage
  • Loading branch information
swalkinshaw committed Aug 25, 2015
2 parents 0a7bdef + a60fa93 commit 8a84639
Showing 1 changed file with 9 additions and 6 deletions.
15 changes: 9 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,12 @@

[![Build Status](https://travis-ci.org/roots/trellis.svg)](https://travis-ci.org/roots/trellis)

Trellis is a set of [Ansible](http://www.ansible.com/home) [playbooks](http://docs.ansible.com/playbooks.html) to automatically configure servers and deploy WordPress sites. It easily creates development environments with Vagrant to help achieve development & production parity.
Trellis is an end-to-end solution for WordPress environment management.
- Reproducible development environments with Vagrant
- Automate the configuration of high-performance production servers
- One-command deploys for your WordPress sites

Configure complete [Bedrock](https://roots.io/bedrock/)-based WordPress ready servers with a single command:
Configure servers for [Bedrock](https://roots.io/bedrock/)-based WordPress sites with a single command:

| | Command
| ---------------------- | ------------------------------------------------ |
Expand Down Expand Up @@ -61,7 +64,7 @@ example.com/ - Primary folder for the project

## Remote server setup (staging/production)

For remote servers you'll need to have a base Ubuntu 14.04 server already created.
For remote servers, you'll need to have a base Ubuntu 14.04 server already created.

1. Configure your [WordPress sites](#wordpress-sites) in `group_vars/<environment>`. Also see the [Passwords wiki](https://github.com/roots/trellis/wiki/Passwords).
2. Add your server IP/hostnames to `hosts/<environment>`.
Expand All @@ -86,7 +89,7 @@ For remote servers you'll need to have a base Ubuntu 14.04 server already create

Before using Trellis, you must configure your WordPress sites. The `group_vars` directory contains one configuration file per environment (`development`, `staging`, and `production` in [YAML](http://en.wikipedia.org/wiki/YAML) format). For example: configure the sites on your Vagrant development VM by editing `group_vars/development`.

`wordpress_sites` is the top level dictionary used to define the WordPress sites, databases, Nginx vhosts, etc that will be created. Each site's variables are nested under a site "key" (e.g., `example.com`). This key is just a descriptive name and serves as the default value for some variables. See our [example project](https://github.com/roots/roots-example-project.com/blob/master/ansible/group_vars/development) for a complete working example.
`wordpress_sites` is the top level dictionary used to define your WordPress sites, databases, Nginx vhosts, etc. Each site's variables live under a site "key" (e.g., `example.com`). This key is just a descriptive name and serves as the default value for some variables. See our [example project](https://github.com/roots/roots-example-project.com/blob/master/ansible/group_vars/development) for a complete working example.

* `site_hosts` - array of hosts that Nginx will listen on (required, include main domain at least)
* `local_path` - path targeting Bedrock-based site directory (required for development)
Expand Down Expand Up @@ -123,12 +126,12 @@ Before using Trellis, you must configure your WordPress sites. The `group_vars`

### Mail

Outgoing mail is handled by sSMTP. For the `development` environment, emails are sent to MailHog, where you can inspect them. To access MailHog interface, go to `http://yourdevelopmentdomain.dev:8025`. For `staging` and `production`, configure credentials in `group_vars/all`. See the [Mail wiki](https://github.com/roots/trellis/wiki/Mail).
sSMTP handles outgoing mail. For the `development` environment, emails are sent to MailHog, where you can inspect them. To access MailHog interface, go to `http://yourdevelopmentdomain.dev:8025`. For `staging` and `production`, configure credentials in `group_vars/all`. See the [Mail wiki](https://github.com/roots/trellis/wiki/Mail).

## SSL

Full SSL support is available for your WordPress sites. Trellis will also *auto-generate* self-signed certificates for development purposes. Our HTTPS implementation has all the best practices for performance and security. (Note: default configuration is HTTPS **only**.) See the [SSL wiki](https://github.com/roots/trellis/wiki/SSL).

## Caching

You can enable FastCGI caching on a per site basis. The cache is a low duration, "micro-cache" type setup. See the [FastCGI micro-caching wiki](https://github.com/roots/trellis/wiki/FastCGI-caching) for configuration options.
You can enable FastCGI caching on a per site basis. The cache is a short duration, "micro-cache" type setup. See the [FastCGI micro-caching wiki](https://github.com/roots/trellis/wiki/FastCGI-caching) for configuration options.

0 comments on commit 8a84639

Please sign in to comment.