readme.md

WordPress Stateless Media Plugin

Description

Upload and serve your WordPress media from Google Cloud Storage (GCS) with the WP-Stateless plugin. In as little as two minutes, you will be benefitting from serving your media from Google Cloud's distributed servers.

New to Google Cloud? Google is offering you a $300 credit to get you started.

Benefits

• Store and deliver media files on Google Cloud Storage instead of your server.
• Google Cloud Storage is geo-redundant, meaning your media is delivered by the closest server - reducing latency and improving page speed.
• Scale your WordPress website across multiple servers without the need of synchronizing media files.
• Native integration between Google Cloud Storage and WordPress.
• $300 free trial from Google Cloud. Nice!

Modes

• Backup - Upload media files to Google Storage and serve local file urls.
• CDN - Copy media files to Google Storage and serve them directly from there.
• Stateless - Store and serve media files with Google Cloud Storage only. Media files are not stored locally.

Features

• Setup assistant makes getting started fast and easy.
• No need to manually create service accounts or buckets - handled automatically.
• Settings panel provides you with further GCS configuration and file url customization.
• Mask the default GCS URL with your own custom domain.
• Automatically replace hardcoded media URLs with GCS equivalents in post editor and meta.
• Batch image thumbnail regeneration.
• Synchronization tools for uploading existing files and images.
• All settings supported with wp-config constants and network setting overrides.
• Multiple modes: Backup, CDN, Stateless.
• All files served in HTTPS mode.
• Multisite compatible.

Support, Feedback, & Contribute

We welcome community involvement via the GitHub repository.

Custom Development

Looking for a unique feature for your next project? Hire us!

Installation

1. Search, install, and activate the WP-Stateless plugin via your WordPress dashboard.
2. Begin WP-Stateless setup assistant at Media > Stateless Setup and click "Get Started Now."
3. Click "Google Login" and sign-in with your Google account.
4. Set a Google Cloud Project, Google Cloud Storage Bucket, and Google Cloud Billing Account and click "Continue."
5. Installation and setup is now complete. Visit Media > Stateless Settings for more options.

For a more detailed installation and setup walkthrough, please see the manual setup instructions on Github.

Frequently Asked Questions

What are the minimum server requirements for this plugin?

Beyond the official WordPress minimum requirements, WP-Stateless requires a minimum PHP version of 5.5 or higher and OpenSSL to be enabled.

What wp-config constants are supported?

For a complete list of supported wp-config constants, please consult the GitHub wiki.

How do I manually generate the Service Account JSON?

The WP-Stateless setup assistant will create the Service Account JSON automatically for you, but you can follow these steps if you choose to create it manually.

1. Visit Google Cloud Console, and go to IAM & Admin > Service accounts.
2. Click Create Service Account and name it wp-stateless.
3. Set the role to Storage > Storage Admin.
4. Check Furnish a new private key and select JSON as the key type.
5. Open the JSON file and copy the contents into the Service Account JSON textarea within the WP-Stateless settings panel.

Where can I submit feature requests or bug reports?

We encourage community feedback and discussion through issues on the GitHub repository.

Can I test new features before they are released?

To ensure new releases cause as little disruption as possible, we rely on a number of early adopters who assist us by testing out new features before they are released. Please contact us if you are interested in becoming an early adopter.

Who maintains this plugin?

Usability Dynamics maintains this plugin by continuing development through it's own staff, reviewing pull requests, testing, and steering the overall release schedule. Usability Dynamics is located in Durham, North Carolina and provides WordPress engineering and hosting services to clients throughout the United States.