Word press, the automated way

WordPress,WordPress,
the automated waythe automated way

Michaël Perrin
Full-stack developer
PHP / Symfony, React, Elasticsearch, …
and WordPress
michael_perrin

A typical WordPressA typical WordPress
set-upset-up

A typical WordPressA typical WordPress
set-upset-up
aka. the "Famous 5-minute install"

…AND MORE STEPS…AND MORE STEPS
Select the theme.

Select the theme.
Install plugins.

Select the theme.
Install plugins.
Configure plugins in WordPress admin interface.

Select the theme.
Install plugins.
Set API keys (eg. MailChimp, Google Maps, etc.)

Select the theme.
Install plugins.
Import data

Select the theme.
Install plugins.
Import data
…

Select the theme.
Install plugins.
Import data
…
Create pages for the theme templates.

WHAT ARE WE GOING TO AUTOMATE?WHAT ARE WE GOING TO AUTOMATE?

1. Infrastructure setup.

2. WordPress configuration.

2. WordPress configuration.
3. WordPress data.

BENEFITS OF AUTOMATIONBENEFITS OF AUTOMATION
Why do we want to automate things?

Because developers are lazy?

Multi-environments (staging, QA, production, …)

Server configuration consistency.

Avoids « It works on my machine ¯_( )_/¯ ».

Easy versioning.

Easy versioning.
Continuous Integration and Deployment.

Easy versioning.
Streamline team work.

Easy versioning.
Faster and predictable deployments.

Easy versioning.
Faster and predictable deployments.
"Cloud-ready".

AutomatingAutomating
infrastructure setupinfrastructure setup

QUICK INTRODUCTION ON DOCKERQUICK INTRODUCTION ON DOCKER

"Lightweight virtualisation".

Each service runs in a separate Docker container.

Many services already have oﬀicial images.

Rule of thumb: one service per container.

Rule of thumb: one service per container.
Works on Linux, Windows, MacOS.

DOCKER: BENEFITSDOCKER: BENEFITS
Very handy for local development and for servers.
Documents and versions the infrastructure of the
project.
Allows to install any version of any dependency.
Easy to update configuration for all environmnents.
Isolation of projects.
Easy to deploy.

CONTAINERS FOR WORDPRESSCONTAINERS FOR WORDPRESS
File system link
Network link
Project files

SETTING UP DOCKER CONTAINERSSETTING UP DOCKER CONTAINERS
docker-compose.yml file at the root of the project:
services:
wordpress:
image: wordpress:5.2-php7.3-fpm-alpine
# ...
database:
image: mysql:5.7
# ...
webserver:
image: nginx:1.14-alpine
# ...

wordpress:
image: wordpress:5.2-php7.3-fpm-alpine
links:
- database:mysql
volumes:
- wordpress_data:/var/www/html
restart: always

database:
image: mysql:5.7
1
2
restart: always3
volumes:4
- db_data:/var/lib/mysql5
environment:6
MYSQL_ROOT_PASSWORD: ${MYSQL_ROOT_PASSWORD}7
MYSQL_DATABASE: ${MYSQL_DATABASE}8
MYSQL_USER: ${MYSQL_USER}9
MYSQL_PASSWORD: ${MYSQL_USER_PASSWORD}10
ports:11
- 3306:330612

restart: always
database:1
image: mysql:5.72
3
volumes:4
environment:6
MYSQL_ROOT_PASSWORD: ${MYSQL_ROOT_PASSWORD}7
MYSQL_DATABASE: ${MYSQL_DATABASE}8
MYSQL_USER: ${MYSQL_USER}9
MYSQL_PASSWORD: ${MYSQL_USER_PASSWORD}10
ports:11
- 3306:330612

environment:
MYSQL_ROOT_PASSWORD: ${MYSQL_ROOT_PASSWORD}
MYSQL_DATABASE: ${MYSQL_DATABASE}
MYSQL_USER: ${MYSQL_USER}
MYSQL_PASSWORD: ${MYSQL_USER_PASSWORD}
database:1
image: mysql:5.72
restart: always3
volumes:4
6
7
8
9
10
ports:11
- 3306:330612

webserver:
image: nginx:1.14-alpine
links:
- wordpress
volumes:
- wordpress_data:/var/www/html
- ./docker/nginx/website.conf:/etc/nginx/conf.d/default.conf:
ports:
- ${WEBSERVER_PORT}:80

.ENV FILE.ENV FILE
MYSQL_ROOT_PASSWORD=my_root_password
MYSQL_DATABASE=wordpress
MYSQL_USER=wordpress
MYSQL_USER_PASSWORD=wordpress_pwd
WEBSERVER_PORT=8000

ENVIRONMENT VARIABLESENVIRONMENT VARIABLES
Specific to an environment. Examples:
Database parameters
Website URLs (eg. root URL of the website, API endpoint, etc.)
Email recipients
May contain sensitive data.
Can be set in:
A .env file
In CI/CD tools like Travis, TeamCity, etc.
Not commited in the project.

PROJECT STRUCTUREPROJECT STRUCTURE

LET'S RUN ITLET'S RUN IT
One command to start Docker containers:
docker-compose up -d

LET'S RUN ITLET'S RUN IT
One command to start Docker containers:
All services are up and running:
+

ADDING SERVICES IS EASYADDING SERVICES IS EASY
Want phpMyAdmin? Update docker-compose.yml:
Access it at
services:
# ...
phpmyadmin:
image: phpmyadmin/phpmyadmin
links:
- database:db
ports:
- 8082:80
http://localhost:8082

Automate WordPressAutomate WordPress
configurationconfiguration

DITCH THE WIZARDDITCH THE WIZARD
Set the language.
Add default admin user.
Configure database parameters.
Define posts URL structure.
Choose a theme.
Install plugins.

WP-CLIWP-CLI
WP-CLI provides a command-line interface for
many actions you might perform in the
WordPress admin.
wp-cli.org

USEFUL WP-CLI COMMANDSUSEFUL WP-CLI COMMANDS
Generate a wp-config.php file with DB parameters:
Run the standard WordPress installation process:
Install and activate plugins:
wp-cli config create --dbhost=… --dbname=… <...>
wp-cli core install --url=… --title=…
wp-cli plugin install contact-form-7 --activate
wp-cli plugin install advanced-custom-fields --activate

HOW TO INSTALLHOW TO INSTALL
Requirements for running WP-CLI:
A PHP installation.
Installing it (on every environment).
Access to the WordPress directory.

HOW TO INSTALLHOW TO INSTALL
Requirements for running WP-CLI:
A PHP installation.
Installing it (on every environment).
Access to the WordPress directory.
Let's use a Docker container!

WP-CLI IN A DOCKER CONTAINERWP-CLI IN A DOCKER CONTAINER
toolbox:
image: michaelperrin/wordpress-toolbox
volumes:
- wordpress_data:/wordpress
- ./Makefile:/scripts/Makefile
depends_on:
- database
environment:
MYSQL_HOST: ${MYSQL_HOST}
MYSQL_DATABASE: ${MYSQL_DATABASE}
MYSQL_USER: ${MYSQL_USER}
MYSQL_USER_PASSWORD: ${MYSQL_USER_PASSWORD}
WORDPRESS_ADMIN_EMAIL: ${WORDPRESS_ADMIN_EMAIL}
WORDPRESS_ADMIN_PASSWORD: ${WORDPRESS_ADMIN_PASSWORD}
WORDPRESS_ADMIN_USER: ${WORDPRESS_ADMIN_USERNAME}
WORDPRESS_DOMAIN_NAME: ${WORDPRESS_DOMAIN_NAME}
WORDPRESS_WEBSITE_URL: ${WORDPRESS_WEBSITE_URL}
WORDPRESS_LOCALE: en_US
WORDPRESS_WEBSITE_POST_URL_STRUCTURE: "/%year%/%monthnum%/%day%/%postname
WORDPRESS_WEBSITE_TITLE: "My beautiful website"

- PHP
- WP-CLI
- Makefile
File system link
Network link
Project files

MAKEFILEMAKEFILE
A file containing a set of scripts grouped as tasks.
Abstracts and groups commands.
The file is versioned in the project.
Run: make task_one
task_one:
# ...
task_two:
# ...
task_three: task_one task_two
# ...

MAKEFILE FOR OUR PROJECTMAKEFILE FOR OUR PROJECT
install: start configure install_plugins set_theme
start:
stop:
docker-compose stop
configure:
# ... (several WP-CLI commands)
set_theme:
docker-compose run --rm toolbox wp-cli theme activate my-simple-t
install_plugins:
# ... (one WP-CLI command per plugin)

ONE COMMANDONE COMMAND
Create Docker containers for WordPress, MySQL and Nginx.
Initiate the WordPress database.
Configure WordPress:
Database parameters.
Default WordPress user.
Set language.
Set default URL structure.
Activate the custom `my-simple-theme` theme.
Install plugins (Contact Form 7 and WP MailChimp as examples).
make install

Automate data changesAutomate data changes

DATA MIGRATION EXAMPLESDATA MIGRATION EXAMPLES
Remove WordPress default content.
Add page and menu entries.
Configure plugins
Add a contact form (Contact Form 7)
Define MailChimp API key
…

WP-MIGRATIONS PLUGINWP-MIGRATIONS PLUGIN

Inspired by for PHP and SQLDoctrine Migrations

Inspired by for PHP and SQL
Runs user-defined migration files to describe
data changes.
Doctrine Migrations

Inspired by for PHP and SQL
Runs user-defined migration files to describe
data changes.
Embeds a WP-CLI command to execute migrations.
Doctrine Migrations

ANATOMY OF A MIGRATIONANATOMY OF A MIGRATION
<?php
namespace Migration;
use WPMigrationMigrationInterface;
class Migration201909221755 implements MigrationInterface
{
public function execute()
{
// ...
}
}

MIGRATION FILESMIGRATION FILES
Stored in wp-content/migrations
Only executed once.
Should be committed to version control.
Executed on deployment.

EXAMPLEEXAMPLE
public function execute() {
$pageData = [
'post_name' => 'about', // Permalink
'post_title' => 'About us',
'post_content' => '',
'post_status' => 'publish',
'post_author' => 1,
'post_type' => 'page',
'menu_order' => 1,
];
$postId = wp_insert_post($pageData);
$this->addToMenu($postId, 'Contact');
}
class Migration201909221755 implements MigrationInterface {1
use MigrationUtilitiesTrait;2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
}19

EXAMPLE 2EXAMPLE 2
class Migration201905311454 implements MigrationInterface {
public function execute() {
$this->setMailChimpApiKey(getenv('MAILCHIMP_API_KEY'));
}
private function setMailChimpApiKey(string $key) {
$options = get_option('mc4wp');
$options['api_key'] = $key;
update_option('mc4wp', $options);
}
}

RUN THE MIGRATIONSRUN THE MIGRATIONS
make wordpress_migrations_execute

RUN THE MIGRATIONS, AGAINRUN THE MIGRATIONS, AGAIN
make wordpress_migrations_execute

BENEFITS OF MIGRATIONSBENEFITS OF MIGRATIONS
Structural changes are versioned.
Facilitate team work and easy to deploy.
No "in-between" state
Multi-environments (using environment variables)

FINAL TREE STRUCTUREFINAL TREE STRUCTURE
Only what our project needs.
Easy versioning.
Includes infrastructure & all
automations.

THANK YOU!THANK YOU!
Twitter:
Demo repository:
Slides (soon):
@michael_perrin
https://github.com/michaelperrin/automated-
wordpress-demo
http://blog.michaelperrin.fr/

Word press, the automated way

Recomendados

Recomendados

Más contenido relacionado

La actualidad más candente

La actualidad más candente (20)

Similar a Word press, the automated way

Similar a Word press, the automated way (20)

Último

Último (20)

Word press, the automated way