Capistrano powered WordPress deployment.
HTML Ruby PHP Shell
Latest commit 1ad082d Jan 6, 2017 @lukewhitehouse lukewhitehouse committed on GitHub Merge pull request #129 from joshuairl/patch-1
Update readme.md

readme.md

wp-deploy

Capistrano powered WordPress deployment.


This repository utilises the Capistrano 3 framework to help the deployment and successful launch of a WordPress based website.

Features

That sounds fancy, but what does it actually do?

  • Install WordPress: WordPress is created at a git submodule* and installed based on your pre-defined configuration.
  • Environment based git deployment: Clone an entire repository (from anywhere) to the server. Have separate environments to deploy to? (think: production/staging) We've got you covered.
  • Deployment rollbacks: Realised you deployed a version thats going to break the site? Run a command to revert your changes to the previous version.
  • Push/Pull database with correct URLs: Override the environment's database and run a 'search and replace' through the database to make sure the URLs are correct for that environment.
  • Push/Pull uploads: Update you entire uploads directory from local to or vice versa.
  • Update WordPress: Update your version of WordPress with ease, straight from the Command Line.
  • Configuration templates: Need specific attributes within your .htaccess or wp-config.php? The templates are designed for this in mind.
  • Setup permissions: Make sure your uploads and .htaccess files are readable from the get-go.
  • Slack integration: Let your teammates know when you're deploying to a server, in addition to when a deployment is successful or not.

Requirements

  • Git > v1.7.3: Git is used to pull down the website from your Git hosting and therefore is a mandatory requirement.
  • SSH access: For wp-deploy (or Capistrano in general) to work you need SSH access both between your local machine and your remote server, and between your local machine and your Git hosting (Github, Bitbucket, CodebaseHQ, etc) account.
  • Bundler: As WP-Deploy comes with various different Ruby Dependencies, Bundler is used to make quick work of the installation process. Here's the link
  • WP-CLI (greater than 0.22.0): WP-Deploy also requires the automation of WordPress functions directly in the Command Line. As these functions are required on all environments (local, staging and production servers), we make use of the WordPress Command Line Interface. You can check out the documentation on how to get this setup.

In addition, as this is powered by WordPress, you'll also need to follow WordPress' requirements.

Unsupported/Untested tech

Some of the following tech is more untested than anything else. This could due to time constraints or unfamiliarity with the software:

  • Nginx
  • Git (lower than version 1.7.3)
  • WP-CLI (lower than version 0.22.0)
  • Capistrano 2 or lower.
  • Another shell besides Bash/Zsh for local development
  • WordPress Multisite

Want to support these? Create a fork of the project, let us know and once vetted we'll happily provide a link in here to your project.

Installation

Take a look at the Installation Guide.

Usage

Take a look at the Usage Guide.

FAQ

Take a look at the Frequently Asked Questions.

Contributing

Take a look at the Contributing guide

Credits

This project is under constant development by the Mixd team. Like it? Hate it? Let us know on Twitter.