putyourlightson / craft-blitz-shell
Shell deployer for the Blitz plugin for Craft CMS.
Installs: 1 150
Dependents: 0
Suggesters: 0
Security: 0
Stars: 2
Watchers: 3
Forks: 1
Open Issues: 0
Type:blitz-deployer
Requires
- php: ^8.2
- craftcms/cms: ^5.0
- putyourlightson/craft-blitz: ^5.0
- symfony/process: ^4.2 || ^5.0 || ^6.0 || ^7.0
Requires (Dev)
- craftcms/ecs: dev-main
- craftcms/phpstan: dev-main
This package is auto-updated.
Last update: 2024-11-08 15:40:38 UTC
README
Blitz Shell Deployer for Craft CMS
The Shell Deployer allows the Blitz plugin for Craft CMS to deploy cached files to remote locations using shell commands.
WARNING: Commands are parsed by the shell of your OS. Use at your own risk.
Usage
Install the deployer using composer.
composer require putyourlightson/craft-blitz-shell
Then add the class to the driverTypes
config setting in config/blitz.php
.
// The deployer type classes to add to the plugin’s default deployer types. 'deployerTypes' => [ 'putyourlightson\blitzshell\ShellDeployer', ],
You can then select the deployer and add shell commands to execute either in the control panel or in config/blitz.php
. The shell commands cal also be defined as an array of arrays in the deployerSettings
setting in config/blitz.php
.
// The deployer type to use. 'deployerType' => 'putyourlightson\blitzshell\ShellDeployer', // The deployer settings. 'deployerSettings' => [ 'commands' => [ ['cp -r ~/mysite.com/web/cache/blitz ~/remote'], ['cp -r ~/mysite.com/web/cache/blitz ~/remote'], ['cp -r ~/mysite.com/web/cache/blitz ~/remote'], ], ],
Documentation
Read the documentation at putyourlightson.com/plugins/blitz.
Created by PutYourLightsOn.