mk-conn/shellax

Some shell helper commands for laravel applications

Shellax

![Software License][ico-license] ![Coverage Status][ico-scrutinizer] ![Total Downloads][ico-downloads], _(*1)

Laravel package to ease deployments - running tasks after deploy/install like cache cleaning, adding supervisor programms ..., _(*2)

Install

Via Composer, _(*3)

``` bash $ composer require mk-conn/shellax, <sub>(*4)</sub>

## Usage

In your `config/app.php` add the Shellax service provider like so:

```php
'providers' => // ... other providers 

    MkConn\Shellax\Providers\ShellaxServiceProvider::class,

Publish the shellax config, <sub>(*5)</sub>

php artisan vendor:publish --provider="MkConn\Shellax\Providers\ShellaxServiceProvider"

Available artisan commands, <sub>(*6)</sub>

php artisan shellax:postintall
php artisan shellax:supervisor-register
php artisan shellax:setup-cron

Configuration

Example configuration, <sub>(*7)</sub>

<?php

$dir = __DIR__;
$dir = realpath($dir . '/..');

return [
    // post install tasks - e.g. cache clearing, running migrations, etc...
    'postinstall' => [
        'artisan' => [
            'shellax:supervisor-register' => [
                '--name'     => 'your-fancy-name-here',
                '--user'     => 'nginx', // user to run the following command
                '--command'  => "/usr/bin/php {$dir}/artisan queue:work --tries=3 --timeout=10",
                '--logfile'  => '/var/log/laravel-queue.log',
                '--numprocs' => '4', // number of processes to run by supervisor
            ]
        ],
        'shell' => [
            '/etc/whatever-should-run -arg1'   
        ]
    ],
    'supervisor'  => [
        'config_dir'         => env('SUPERVISOR_CONFIG_DIR', '/etc/supervisor.d'),
        'config_ext'         => env('SUPERVISOR_CONFIG_EXT', '.conf'),
        'supervisor_bin_dir' => env('SUPERVISOR_BIN_DIR', '/usr/bin')
    ]
];

Change log

Please see CHANGELOG for more information what has changed recently., <sub>(*8)</sub>

Testing

bash $ composer test, <sub>(*9)</sub>

Contributing

Please see CONTRIBUTING and CONDUCT for details., <sub>(*10)</sub>

Security

If you discover any security related issues, please email :author_email instead of using the issue tracker., <sub>(*11)</sub>

Credits

• mk-conn
• All Contributors

License

The MIT License (MIT). Please see License File for more information., <sub>(*12)</sub>