Forge Home

wordpress

Puppet Module for managing Wordpress

6,484 downloads

4,425 latest version

5.0 quality score

We run a couple of automated
scans to help you access a
module's quality. Each module is
given a score based on how well
the author has formatted their
code and documentation and
modules are also checked for
malware using VirusTotal.

Please note, the information below
is for guidance only and neither of
these methods should be considered
an endorsement by Puppet.

Support the Puppet Community by contributing to this module

You are welcome to contribute to this module by suggesting new features, currency updates, or fixes. Every contribution is valuable to help ensure that the module remains compatible with the latest Puppet versions and continues to meet community needs. Complete the following steps:

  1. Review the module’s contribution guidelines and any licenses. Ensure that your planned contribution aligns with the author’s standards and any legal requirements.
  2. Fork the repository on GitHub, make changes on a branch of your fork, and submit a pull request. The pull request must clearly document your proposed change.

For questions about updating the module, contact the module’s author.

Version information

  • 1.0.2 (latest)
  • 1.0.1
  • 1.0.0
released May 19th 2019
This version is compatible with:
  • Puppet Enterprise 2018.1.x, 2017.3.x, 2017.2.x, 2017.1.x, 2016.4.x
  • Puppet >=4.9.0 <6.0.0
  • , , ,

Start using this module

  • r10k or Code Manager
  • Bolt
  • Manual installation
  • Direct download

Add this module to your Puppetfile:

mod 'bodgit-wordpress', '1.0.2'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add bodgit-wordpress
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install bodgit-wordpress --version 1.0.2

Direct download is not typically how you would use a Puppet module to manage your infrastructure, but you may want to download the module in order to inspect the code.

Download
Tags: wordpress

Documentation

bodgit/wordpress — version 1.0.2 May 19th 2019

wordpress

Tested with Travis CI

Build Status Coverage Status Puppet Forge

Table of Contents

  1. Description
  2. Setup - The basics of getting started with wordpress
  3. Usage - Configuration options and additional functionality
  4. Reference - An under-the-hood peek at what the module is doing and how
  5. Limitations - OS compatibility, etc.
  6. Development - Guide for contributing to the module

Description

This module manages Wordpress installations.

CentOS, RHEL, Scientific and Oracle Enterprise Linux is supported using Puppet 4.9.0 or later. SELinux is managed so it can remain enabled.

Setup

Setup Requirements

You will need to have already instantiated the puppetlabs/mysql and bodgit/php modules prior to using this module.

Beginning with wordpress

In the very simplest case, you can just include the base class which doesn't do anything apart from install the necessary PHP extensions.

class { '::mysql::server':
  root_password => 'password',
}

include ::php
include ::wordpress

Usage

To create a Wordpress instance:

class { '::mysql::server':
  root_password => 'password',
}

include ::php
include ::wordpress

::wordpress::instance { '/srv/wordpress':
  owner       => 'apache',
  db_name     => 'wordpress',
  db_user     => 'wordpress',
  db_password => 'secret',
}

Getting the file ownership right is the hardest part depending on what webserver will be doing the serving. The above will work fine for Apache using mod_php which you can extend with the necessary vhost:

class { '::mysql::server':
  root_password => 'password',
}

include ::php
include ::wordpress

::wordpress::instance { '/srv/wordpress':
  owner       => 'apache',
  db_name     => 'wordpress',
  db_user     => 'wordpress',
  db_password => 'secret',
}

class { '::apache':
  default_mods  => false,
  default_vhost => false,
}

include ::apache::mod::dir
include ::apache::mod::php

::apache::vhost { 'wordpress':
  docroot     => '/srv/wordpress',
  directories => [
    {
      'path'           => '/srv/wordpress',
      'allow_override' => [
        'FileInfo',
      ],
      'directoryindex' => 'index.php',
      'options'        => [
        'FollowSymlinks',
      ],
    },
    {
      'path'       => '\\.php$',
      'provider'   => 'filesmatch',
      'sethandler' => 'application/x-httpd-php',
    },
  ],
  port        => 80,
  servername  => 'example.com',
  require     => ::Wordpress::Instance['/srv/wordpress'],
}

If you prefer to use the PHP FastCGI Process Manager (which is recommended), then the above can be rewritten as follows:

class { '::mysql::server':
  root_password => 'password',
}

include ::php
include ::php::fpm
include ::wordpress

group { 'wordpress':
  ensure     => present,
  forcelocal => true,
}

user { 'wordpress':
  ensure   => present,
  comment  => 'Wordpress',
  gid      => 'wordpress',
  home     => '/srv/wordpress',
  password => '*',
  shell    => '/sbin/nologin',
}

::wordpress::instance { '/srv/wordpress':
  owner       => 'wordpress',
  db_name     => 'wordpress',
  db_user     => 'wordpress',
  db_password => 'secret',
}

::php::fpm::pool { 'wordpress':
  listen          => '/var/run/httpd/wordpress.sock',
  listen_owner    => 'apache',
  listen_group    => 'apache',
  listen_mode     => '0666',
  pm              => 'static',
  pm_max_children => 5,
  user            => 'wordpress',
  require         => ::Wordpress::Instance['/srv/wordpress'],
}

class { '::apache':
  default_mods  => false,
  default_vhost => false,
}

include ::apache::mod::dir
include ::apache::mod::proxy
include ::apache::mod::proxy_fcgi

::apache::vhost { 'wordpress':
  docroot       => '/srv/wordpress',
  docroot_owner => 'wordpress',
  docroot_group => 'wordpress',
  directories   => [
    {
      'path'           => '/srv/wordpress',
      'allow_override' => [
        'FileInfo',
      ],
      'directoryindex' => 'index.php',
      'options'        => [
        'FollowSymlinks',
      ],
    },
    {
      'path'       => '\\.php$',
      'provider'   => 'filesmatch',
      'sethandler' => 'proxy:unix:/var/run/httpd/wordpress.sock|fcgi://localhost/',
    },
  ],
  port          => 80,
  servername    => 'wordpress',
  require       => ::Php::Fpm::Pool['wordpress'],
}

Reference

The reference documentation is generated with puppet-strings and the latest version of the documentation is hosted at https://bodgit.github.io/puppet-wordpress/.

Limitations

This module has been built on and tested against Puppet 4.9.0 and higher.

The module has been tested on:

  • CentOS Enterprise Linux 6/7

Currently the module assumes the MySQL database is local to the installation.

Development

The module has both rspec-puppet and beaker-rspec tests. Run them with:

$ bundle exec rake test
$ PUPPET_INSTALL_TYPE=agent PUPPET_INSTALL_VERSION=x.y.z bundle exec rake beaker:<nodeset>

Please log issues or pull requests at github.