Giter Club home page Giter Club logo

wp-deploy's Introduction

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 and allow you to do this on an environment by environment basis.
  • Setup permissions: Make sure your uploads and .htaccess files are readable from the get-go.

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 be 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 3.8 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 developed by the Mixd team. Like it? Hate it? Let us know on Twitter.

wp-deploy's People

Contributors

lukewhitehouse avatar drizzlyowl avatar roryashfordbentley avatar joris-ati4 avatar achilles283 avatar ed-richards avatar jimchestnutt avatar peerbolte avatar rs-georg avatar dependabot[bot] avatar mattclements avatar coire1 avatar kjbrum avatar jfrux avatar hazemkhaled avatar emmabritnor avatar davenaylor avatar

Watchers

Alois Rietzler avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.