https://github.com/putyourlightson/craft-blitz-shell

Blitz Shell Deployer for Craft CMS
https://github.com/putyourlightson/craft-blitz-shell

Last synced: 10 months ago
JSON representation

Blitz Shell Deployer for Craft CMS

• Host: GitHub
• URL: https://github.com/putyourlightson/craft-blitz-shell
• Owner: putyourlightson
• License: other
• Created: 2019-12-18T00:56:05.000Z (over 6 years ago)
• Default Branch: develop
• Last Pushed: 2024-04-08T14:16:15.000Z (about 2 years ago)
• Last Synced: 2024-11-13T13:54:52.453Z (over 1 year ago)
• Language: PHP
• Size: 29.3 KB
• Stars: 2
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.md

Awesome Lists containing this project

README

          
[![Stable Version](https://img.shields.io/packagist/v/putyourlightson/craft-blitz-shell?label=stable)]((https://packagist.org/packages/putyourlightson/craft-blitz-shell))

[![Total Downloads](https://img.shields.io/packagist/dt/putyourlightson/craft-blitz-shell)](https://packagist.org/packages/putyourlightson/craft-blitz-shell)



# Blitz Shell Deployer for Craft CMS

The Shell Deployer allows the [Blitz](https://putyourlightson.com/plugins/blitz) plugin for [Craft CMS](https://craftcms.com/) 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.

```shell

composer require putyourlightson/craft-blitz-shell

```

Then add the class to the `driverTypes` config setting in `config/blitz.php`.

```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`.

```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](https://putyourlightson.com/plugins/blitz#remote-deployment).

Created by [PutYourLightsOn](https://putyourlightson.com/).