AWS S3 Setup for WordPress
Add the ability to integrate with AWS S3 to a WordPress site on Pantheon
Contributors: Sarah German
Amazon Web Services (AWS) offers Simple Storage Service (S3) for scalable storage and content distribution, which can be integrated with sites running on Pantheon. Pantheon already offers content distrubution through the Global CDN, but S3 is a good option for addressing issues with highly populated directories or serving large files.
Before You Begin
Be sure that you have:
- An existing WordPress site on Pantheon, or create one.
- A local clone of your code repository.
- An account with Amazon Web Services (AWS). Amazon offers free access to most of their services for the first year.
- Terminus installed on your local computer.
When creating an AWS account, you will have to enter credit card information. This is required, but you will not be charged unless you exceed the usage limits of their free tier.
This process uses Terminus commands. Before we begin, set the variable
$site in your terminal session to match your site name:
export site=yoursitename export env=dev
Configure S3 within the AWS Console
Before integrating S3 with your site, you'll need to configure the service within your AWS Management Console.
Create a New AWS S3 Bucket
If you do not have an existing bucket for your site, create one:
- From your AWS Console, click S3.
- Click Create Bucket.
- Enter a bucket name. The bucket name you choose must be unique across all existing bucket names in Amazon S3, and after you create a bucket, you cannot change its name. Because the bucket name is visible in the URL that points to the objects stored in the bucket, ensure that the bucket name you choose is appropriate.
- Select a region and click Create.
- The Set properties section has additional configuration options you can configure now, or wait and configure later. When complete, click Next.
- In the Permissions tab, tick the boxes for Read and Write access for both Objects and Permissions, then click Next.
- Review your settings, and then click Create bucket.
Integrate S3 with WordPress
WP Offload Media requires a paid license but is configurable in the WordPress admin UI and offers a number of options and features, including multisite support. S3 Uploads is open-source but does not include an admin UI and requires Terminus and WP-CLI for setup and migration.
Install and Deploy S3 Uploads
Download the latest plugin release from Github and extract it to
wp-content/plugins/. Note that our documentation has been tested for version 2.0.0.
Do not add the plugin as a Git submodule. Git submodules are not supported on the platform (more info).
Rename the extracted folder to remove the version number. For example:
mv S3-Uploads-2.0.0/ S3-Uploads
Create and / or copy your Access Key ID key and Secret Access Key from the "My security credentials" section of your AWS account to a text editor on your local computer.
As a standard security measure, consider creating a unique user with limited permissions covering this S3 bucket to authenticate the plugin.
Add the credentials to
wp-config.php, as described in the plugin's README file. For security, we recommended a service like Lockr or the Terminus Secrets plugin to store and retrieve these credentials securely.
Commit and push the new plugin and your
wp-config.phpupdates to the Dev environment, then switch to SFTP mode and activate the plugin:
terminus wp $site.dev plugin activate S3-Uploads
Use WP-CLI to verify your AWS setup.
terminus wp $site.dev s3-uploads verify
Migrate existing media using S3 Uploads and WP-CLI
You can migrate existing media files to S3 with the following command:
terminus wp $site.dev -- s3-uploads migrate-attachments
Optionally, add the
--delete-local flag to remove the local copies of the media files.
Upon succesful migration, this command will also provide a search/replace command for your database to update references to the newly-migrated files. Note that you will need to run this on all Pantheon environments (dev/test/live).
Check out the plugin's README file for information on advanced configuration, such as cache control, URL rewriting and offline development.
Install and Deploy WP Offload Media
Follow documentation from DeliciousBrains. No specialized configuration is required for this plugin to run on Pantheon.