WordPress

This role deploys WordPress instances including plugins and their configuration.

Requirements

This role requires the php-fpm role, the nginx role and the maria db role.

Role Variables

The role has one main top-level variable wordpress_instances, which is a list of dicts. Additionally there are some global defaults (see defaults/main.yaml).

General

Each entry in wordpress_instances describes one WordPress instance which will be available in /var/www/wordpress-{{instance.name}}. A temporary directory for each instance will be created at /var/www/wordpress-{{instance.name}}/wp-content/tmp and should be configured accordingly in php. A lot of configuration keys are available, only the most important ones are described here. The variables described in the defaults are used as default if a WordPress instance does not contain the respective key (e.g. if the instance does not define admins, wordpress_default_admins is used).

Only the variables name, siteurl, home, mysql_user, mysql_password, table_prefix, admins, plugins and related options are evaluated and used on each role execution. All other variables are only used when WordPress is installed.

Name	Required/Default	Description
name	✔️	A name to describe the instance. This is used e.g. to name the WordPress folder, the database and the database user of this instance.
siteurl	✔️	The basename of the domain where this WordPress instance should be reachable, e.g. https://example.com.
home	✔️	The homepage of the WordPress instance
blogname	✔️	The blog name (title) of this WordPress instance
blogdescription	✔️	The description of the WordPress instance
default_user	admin	The user that is created on setup
default_password	✔️	The password that is used for the default user
default_email	webmaster@example.com	The email address for the default user
template	twentyseventeen	The name of the WordPress template being in use
stylesheet	twentyseventeen	What stylesheet should be used for the WordPress instance
admins	{}	List of admins to be created. For more information see Admins
plugins	[]	List of plugins to install and options to set. For more information see Plugins
plugin_merge_default	True	Default decision whether the existing plugin options should be merged or overwritten by the ones defined in the role variables.

Database Connection

Name	Required/Default	Description
mysql_host	localhost	The host to use for connecting to the database. Set to localhost:/path/to/mysqld/socket to use a Unix socket instead.
mysql_user	{{instance.name}}	The MySQL user to use for this instance
mysql_create_user	True	Whether to create the MySQL user if it doesn't exist
mysql_db	{{instance.name}}	The database to create and use for this instance
mysql_create_db	True	Whether to create the database if it doesn't exist
mysql_password	✔️	The password for the MySQL user
table_prefix	wp_	The database to create and use for this instance

Environment Variables for Database Connection

wp-config.php will not contain any MySQL credentials and instead read them from the environment variables ANSIBLE_WORDPRESS_DB_HOST, ANSIBLE_WORDPRESS_DB_NAME, ANSIBLE_WORDPRESS_DB_USER, and ANSIBLE_WORDPRESS_DB_PASSWORD. This role is not responsible to actually set these environment variables (except in the context of tasks performed by this role), so you need to add them to the PHP config yourself. In order to be compatible with this role's defaults, you should set the environment variables as follows:

env[ANSIBLE_WORDPRESS_DB_HOST] = {{ wp_instance.mysql_host | default('localhost:/var/run/mysqld/mysqld.sock') }}
env[ANSIBLE_WORDPRESS_DB_NAME] = {{ wp_instance.mysql_db | default(wp_instance.name | mandatory) }}
env[ANSIBLE_WORDPRESS_DB_USER] = {{ wp_instance.mysql_user | default(wp_instance.name | mandatory) }}
env[ANSIBLE_WORDPRESS_DB_PASSWORD] = {{ wp_instance.mysql_password | mandatory }}

Mail

Name	Required/Default	Description
mailserver_url	mail.example.com	URI of the mail server
mailserver_login	login@example.com	Login name for the mail serer
mailserver_pass	password	Password for the mail server
mailserver_port	110	Port for the mail server

Importing

Name	Required/Default	Description
import_template	False	If this is true ansible will try to extract a zip file from files/{{inventory_hostname}}/{{instance.name}}{{ wordpress_template }}.zip and install it in the WordPress instance
import_wp_content	False	If this is True, Ansible will try to copy the wp-content directory over to the remote host from files/{{inventory_hostname}}/{{instance.name}}/wp-content/
import_db_file	False	If this is True, Ansible will try to import a sql file from files/{{inventory_hostname}}/{{instance.name}}/wordpress.sql
import_replace_siteurls	[]	List of domains to replace with {{instance.siteurl}} in the SQL file before importing it, e.g. http://www.example.com.

Plugins

plugins is a list of dicts with the following keys:

Name	Required/Default	Description
name	✔️	The name(slug) of the plugin to be installed
merge	{{ instance.plugin_merge_default }}	Setting whether the options should be merged or overwritten
options	✔️	Dict containing the plugin options (the key is the same key as in the WordPress database)
update	True	If this is False, this plugin will be excluded from updating. By default, all plugins are updated, even if they're not configured in the plugins list.

Admins

admins is a dict of admins to be created, using the key as admin name. Example:

wordpress_default_admins:
  admin:
    email: admin@example.com

If no password is set, a random password will be set, which can be reset via the specified email address. Alternatively, plugins that supply the password like authorizer may be used.

Name	Required/Default	Description
email	✔️	The email address of the admin.
name	✔️	The display name of the admin.
password	✖️	The plain text password of the admin.

Example

wordpress_instances:
  - name: mainsite
    blogname: Wordpress test
    blogdescription: Wordpress test description
    home: https://example.com
    siteurl: https://example.com
    mysql_password: changeme
    default_user: alice
    default_password: pleasechangemealice
    default_email: alice@example.com
    admin_email: webmaster@example.com

License

This work is licensed under a Creative Commons Attribution-ShareAlike 4.0 International License.

Author Information

• Fritz Otlinghaus(Scriptkiddi) fritz.otlinghaus@stuvus.uni-stuttgart.de
• Michel Weitbrecht(SlothOfAnarchy) michel.weitbrecht@stuvus.uni-stuttgart.de
• Adriaan Nieß(AdriaanNiess) adriaan.niess@stuvus.uni-stuttgart.de