Skip to content

Latest commit

 

History

History
24 lines (16 loc) · 1.21 KB

setup.md

File metadata and controls

24 lines (16 loc) · 1.21 KB

Setup Guide

Build the plugin

This plugin uses composer as a package manager. After downloading the plugin (as a ZIP file or via git pull) run one of the following commands:

  • For production: composer install --no-dev --optimize-autoloader
  • For development: composer install

Running one of the above commands will create a vendor directory which is required for the plugin to function correctly. Applications that are using CI/CD already run one of these commands automatically and can skip this step.

Activate the plugin

  1. Commit the plugin to your application's plugins directory.
  2. Activate the plugin through code or within the WordPress Admin dashboard.
  3. Create an IAM user with Programmatic Access.
  4. Enter the provided AWS S3 API keys on the plugins's Settings page.
  5. Backfill the uploads directory on AWS by running the following command:
wp s3-media upload-all --url=example-site.com

For more detailed instructions on setting up the AWS permissions, see the AWS Setup Guide.