[1.x] Allow easy customization of the command ran by supervisor's PHP process

[bram-pkg]

This PR adds the capability to control supervisor's PHP process command using an environment variable, potentially simplifying the installation of Laravel Octane into dev envs using Laravel Sail.

Allowing for customization of the command ran by supervisor through an environment variable removes the need to publish all the underlying files used to build the image, in the simple use case of running Octane under Sail.

This does not introduce a breaking change, luckily, as changes to both the supervisord.conf and Dockerfile only apply after a rebuild, hence not affecting current users. After rebuilding (optional for current users), nothing would break either, as the environment variable has a sane default value that is equal to the current behaviour.

[taylorotwell]

In the Supervisor configuration, why are the variables prefixed with ENV_SUPERVISOR_? I can find no reference to this in the Supervisor documentation, only prefixing with ENV_.

[taylorotwell]

Mark as ready for review when answered please.

[bram-pkg]

Oops, that was not meant to be like that. I've amended the variables in the Dockerfile files

[taylorotwell]

So, that leads me to my next question: was this tested at all? 😅

[bram-pkg]

Yes, I've got this running locally. Reason it was renamed was that I published the docker files in one of my projects to test this out, but decided to make the env var name more descriptive 😅 Simply forgot to include it in all places when committing to the fork.

It's working in my project now, together with the env var overridden in the docker-compose.yaml to run the Laravel Octane command rather than artisan serve

[bram-pkg]

So for context, @taylorotwell, I have this in my docker-compose.yaml:

environment:
  # other env vars
  SUPERVISOR_PHP_COMMAND: "/usr/bin/php -d variablescommand=/usr/bin/php -d variables_order=EGPCS /var/www/html/artisan octane:frankenphp --host=0.0.0.0 --admin-port=2019 --port=80"

Which is working just fine :)

[taylorotwell]

Can you send in a documentation PR to the Octane docs for this?

[bram-pkg]

Yep, can do.

Do you want it to mention "Since 1.27.0"? @taylorotwell

[RahulDey12]

@taylorotwell @bram-pkg Hey guys, these changes work but I recommend not to use this instruction with octane because octane runs like a demon which doesn't load the new code changes to the memory because of this if we change something it doesn't affect the application. Technically we can still use this with --watch param but watching file changes depends on the chokidar plugin which gives extra dependency to the application.

[bram-pkg]

The behaviour of the daemon was not changed in this PR, adding the --watch parameter was not part of the original documentation for this customization either.

Adding the --watch parameter is documented here, and you can add that to the environment variable set as part of this PR.
https://laravel.com/docs/10.x/octane#watching-for-file-changes

[RahulDey12]

Yeah but if someone add the

SUPERVISOR_PHP_COMMAND: "/usr/bin/php -d variablescommand=/usr/bin/php -d variables_order=EGPCS /var/www/html/artisan octane:frankenphp --host=0.0.0.0 --admin-port=2019 --port=80"

to their code and start working as usual they will find that any changes they are doing is not affecting to the browser then they will discover that it happened because of the octane start without watching the file changes

[bram-pkg]

Yes, which is why there is a section in the documentation about "watching for file changes"