https://github.com/positiondev/position-trellis
Position "fork" of trellis
https://github.com/positiondev/position-trellis
Last synced: 11 months ago
JSON representation
Position "fork" of trellis
- Host: GitHub
- URL: https://github.com/positiondev/position-trellis
- Owner: positiondev
- License: mit
- Created: 2016-12-07T23:36:52.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2016-12-30T14:15:54.000Z (about 9 years ago)
- Last Synced: 2025-01-15T10:02:31.336Z (about 1 year ago)
- Language: Python
- Size: 76.2 KB
- Stars: 0
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Trellis
[](https://github.com/roots/trellis/releases)
[](https://travis-ci.org/roots/trellis)
Ansible playbooks for setting up a LEMP stack for WordPress.
- Local development environment with Vagrant
- High-performance production servers
- One-command deploys for your [Bedrock](https://roots.io/bedrock/)-based WordPress sites
## What's included
Trellis will configure a server with the following and more:
* Ubuntu 16.04 Xenial LTS
* Nginx (with optional FastCGI micro-caching)
* PHP 7.0
* MariaDB (a drop-in MySQL replacement)
* SSL support (scores an A+ on the [Qualys SSL Labs Test](https://www.ssllabs.com/ssltest/))
* Let's Encrypt integration for free SSL certificates
* HTTP/2 support (requires SSL)
* Composer
* WP-CLI
* sSMTP (mail delivery)
* MailHog
* Memcached
* Fail2ban
* ferm
## Requirements
Make sure all dependencies have been installed before moving on:
* [Ansible](http://docs.ansible.com/ansible/intro_installation.html#latest-releases-via-pip) >= 2.0.2 (except 2.1.0)
* [Virtualbox](https://www.virtualbox.org/wiki/Downloads) >= 4.3.10
* [Vagrant](https://www.vagrantup.com/downloads.html) >= 1.8.5
* [vagrant-bindfs](https://github.com/gael-ian/vagrant-bindfs#installation) >= 0.3.1 (Windows users may skip this)
* [vagrant-hostmanager](https://github.com/smdahlen/vagrant-hostmanager#installation)
## Installation
The recommended directory structure for a Trellis project looks like:
```shell
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](https://github.com/roots/roots-example-project.com).
1. Create a new project directory: `$ mkdir example.com && cd example.com`
2. Clone Trellis: `$ git clone --depth=1 git@github.com:positiondev/position-trellis.git trellis && rm -rf trellis/.git`
3. Clone Bedrock: `$ git clone --depth=1 git@github.com:positiondev/tni-bedrock.git site && rm -rf site/.git`
4. Install the Ansible Galaxy roles: `$ cd trellis && ansible-galaxy install -r requirements.yml`
Windows user? [Read the Windows docs](https://roots.io/trellis/docs/windows/) for slightly different installation instructions. VirtualBox is known to have poor performance in Windows — use VMware or [see some possible solutions](https://discourse.roots.io/t/virtualbox-performance-in-windows/3932).
## Documentation
Trellis documentation is available at [https://roots.io/trellis/docs/](https://roots.io/trellis/docs/).
## Local development setup
1. Configure your WordPress sites in `group_vars/development/wordpress_sites.yml` and in `group_vars/development/vault.yml`
2. Run `vagrant up`
[Read the local development docs](https://roots.io/trellis/docs/local-development-setup/) for more information.
## Remote server setup (staging/production)
A base Ubuntu 16.04 server is required for setting up remote servers. OS X users must have [passlib](http://pythonhosted.org/passlib/install.html#installation-instructions) installed.
1. Configure your WordPress sites in `group_vars//wordpress_sites.yml` and in `group_vars//vault.yml` (see the [Vault docs](https://roots.io/trellis/docs/vault/) 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](https://roots.io/trellis/docs/ssh-keys/))
4. Run `ansible-playbook server.yml -e env=` to provision the server
[Read the remote server docs](https://roots.io/trellis/docs/remote-server-setup/) 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
3. Run `./bin/deploy.sh `
4. To rollback a deploy, run `ansible-playbook rollback.yml -e "site= env="`
[Read the deploys docs](https://roots.io/trellis/docs/deploys/) for more information.
## Contributing
Contributions are welcome from everyone. We have [contributing guidelines](https://github.com/roots/guidelines/blob/master/CONTRIBUTING.md) to help you get started.
## Community
Keep track of development and community news.
* Participate on the [Roots Discourse](https://discourse.roots.io/)
* Follow [@rootswp on Twitter](https://twitter.com/rootswp)
* Read and subscribe to the [Roots Blog](https://roots.io/blog/)
* Subscribe to the [Roots Newsletter](https://roots.io/subscribe/)
* Listen to the [Roots Radio podcast](https://roots.io/podcast/)