helppc/supervisor-rest-bundle

Manage your supervisor instance in your Symfony5 application.

v1.0.5 2021-03-17 15:24 UTC

Requires

• php: >=7.4
• ext-curl: *
• ext-json: *
• jms/serializer-bundle: ^3.7
• nelmio/api-doc-bundle: ^3.7
• nyholm/psr7: ^1.3
• supervisorphp/supervisor: ^4.0
• symfony/flex: ^1.3.1
• symfony/framework-bundle: ^4.4 || ^5.1
• symfony/http-client: ^4.4 || ^5.1
• symfony/validator: ^4.4 || ^5.1
• symfony/yaml: ^4.4 || ^5.1

Requires (Dev)

• phpstan/phpstan: ^0.12.48

Suggests

• php-http/httplug-bundle: to provide required HTTP client with ease.

MIT

• Tomáš Kulhánek

• rpc
• api
• supervisor
• supervisord
• supervisorctl

README

Symfony bundle which manage supervisor process. Bundle is implemented using the supervisorphp/supervisor library.

Status

This package is currently in the active development.

Requirements

• PHP 7.4 or greater
• Symfony 5.x

Installation

1. Require the bundle and a PSR 7/17 implementation with Composer:

   composer require helppc/supervisor-bundle nyholm/psr7

   NOTE: This bundle requires a PSR 7/17 implementation to operate. We recommend that you use nyholm/psr7. Check out this document if you wish to use a different implementation.

2. Create the bundle configuration file under config/packages/helppc_supervisor.yaml. Here is a reference configuration file:

   supervisor:
     default_environment: all
     servers:
       all:
         localhost:
           scheme: http
           host: 127.0.0.1
           port: 9006

3. Enable the bundle in config/bundles.php by adding it to the array:

   HelpPC\Bundle\SupervisorRestBundle\SupervisorRestBundle::class => ['all' => true]

4. Import the routes inside your config/routes/helppc_supervisor.yaml file:

   supervisor:
     resource: "@SupervisorRestBundle/Resources/config/routing.xml"
     prefix:   /supervisor

❮ NOTE ❯ It is recommended to control the access to the authorization endpoint so that only logged in users can approve authorization requests. You should review your security.yml file. Here is a sample configuration:

security:
    access_control:
        - { path: ^/supervisor, roles: IS_AUTHENTICATED_REMEMBERED }

Reporting issues

Use the issue tracker to report any issues you might have.

License

See the LICENSE file for license rights and limitations (MIT).