bitpoke/stack-mu-plugin

WordPress must-use plugin for Stack

v0.8.0 2022-10-11 10:29 UTC

Requires

• php: >=7.4
• composer/installers: ^1.9 || ^2.0
• google/auth: ^1.21.0
• google/cloud-storage: ^1.28
• oscarotero/env: ^2.1
• promphp/prometheus_client_php: ^2.1
• vlucas/phpdotenv: >=4.1.8 <6

Requires (Dev)

• dealerdirect/phpcodesniffer-composer-installer: ~0.7.1
• johnkary/phpunit-speedtrap: ^4.0
• phpunit/phpunit: ^5.7 || ^6.5 || ^7.5
• roave/security-advisories: dev-latest
• roots/wordpress: ^5.6
• roots/wp-config: 1.0.0
• squizlabs/php_codesniffer: ^3.6.2
• wp-coding-standards/wpcs: ~2.3.0
• wpackagist-plugin/debug-bar: ^1.0
• wpackagist-plugin/debug-bar-console: ^0.3.0
• wpackagist-plugin/debug-bar-constants: ^2.0
• yoast/phpunit-polyfills: ^1.0

Apache-2.0

• Bitpoke

README

Bitpoke Stack must use plugin for WordPress.

It provides integration for Bitpoke Stack functionalities with WordPress, such as:

• uploading and serving media files from object storage systems such as Google Cloud Storage or AWS S3
• object-cache implementation on top of memcached
• offloading assets to a CDN

Install

Bedrock

When using bedrock, just run:

$ composer require bitpoke/stack-mu-plugin

WordPress plugin

To run as WordPress classic mu-plugin, download the plugin archive from https://github.com/bitpoke/stack-mu-plugin/releases and extract it into your wp-content/mu-plugins folder.

Then you need to activate the mu-plugin, by copying stack-mu-plugin.php from wp-content/mu-plugins/stakc-mu-plugin into your wp-content/mu-plugins folder.

$ cp wp-content/mu-plugins/stack-mu-plugin/stack-mu-plugin.php wp-content/mu-plugins/

WordPress Object Cache

In order to use the custom object cache, you'll need to copy it into the root of WP_CONTENT_DIR (usually wp-content).

$ cp wp-content/mu-plugins/stack-mu-plugin/src/object-cache.php wp-content/

Enable and use a CDN for static files

All that is needed is setting the CDN_HOST variable in wp-config.php and of course a CNAME record in your DNS manager pointing to your CDN provider.

For example, we might use in our config file:

define('CDN_HOST', 'cdn.bitpoke.io');

Development

Clone this repository, copy .env.example to .env and edit it accordingly.

To install dependencies just run

$ make dependencies

Development server

To start a local development server you need wp-cli installed. To start the development server, just run

$ wp server

Testing

Running plugin tests:

$ make test-runtime

Running integration tests:

$ make test-runtime