-
Notifications
You must be signed in to change notification settings - Fork 56
Add details to runtimes deployement, request flow #871
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. Weβll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from all commits
4e9f017
53901a4
6bc5f91
2790793
9f45184
7f7cc7b
5755b65
84f96a8
c6a4bb8
71792ad
33893d7
a893074
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -32,8 +32,8 @@ | |||||
| ```bash | ||||||
| clever create --type frankenphp | ||||||
| ``` | ||||||
| * [Learn more about Clever Tools](/doc/cli/) | ||||||
| * [Learn more about Clever Cloud application deployment](/doc/quickstart/#create-an-application-step-by-step) | ||||||
| - [Learn more about Clever Tools](/doc/cli/) | ||||||
| - [Learn more about Clever Cloud application deployment](/doc/quickstart/#create-an-application-step-by-step) | ||||||
|
|
||||||
| > [!NOTE] FrankenPHP applications can't be deployed on a pico instance, XS is the default instance type | ||||||
|
|
||||||
|
|
@@ -43,19 +43,19 @@ | |||||
|
|
||||||
| FrankenPHP runtime only requires a working web application, with an `index.php` or `index.html` file. If you need to serve files from a specific directory, set the `CC_WEBROOT` environment variable, relative to the root of your project (default: `/`). | ||||||
|
|
||||||
| * [Learn more about environment variables on Clever Cloud](/doc/reference/reference-environment-variables/) | ||||||
| - [Learn more about environment variables on Clever Cloud](/doc/reference/reference-environment-variables/) | ||||||
|
|
||||||
| ### FrankenPHP version and tools | ||||||
|
|
||||||
| FrankenPHP currently deployed version on Clever Cloud is `1.9.1` based on PHP `8.4.12` and Caddy server `2.10.2`. Virtual machine image includes multiple tools from the PHP ecosystem such as Composer or Symfony CLI. | ||||||
| FrankenPHP currently deployed version on Clever Cloud is `{{< runtime_version frankenphp >}}` based on PHP `{{< runtime_version frankenphp php >}}` and Caddy server `{{< runtime_version frankenphp caddy >}}`. Virtual machine image includes multiple tools from the PHP ecosystem such as Composer or Symfony CLI. The `php` command available in hooks and scripts uses `frankenphp php-cli` under the hood. | ||||||
|
|
||||||
| - [FrankenPHP PHP info](https://frankenphpinfo.cleverapps.io/) | ||||||
|
|
||||||
| ### Composer native support | ||||||
|
|
||||||
| If a `composer.json` file is detected at the root of your project, it will be used to install dependencies during building phase with `--no-interaction --no-progress --no-scripts --no-dev` flags. To use your own, set the `CC_PHP_COMPOSER_FLAGS`environment variable. | ||||||
| If a `composer.json` file is detected at the root of your project, it will be used to install dependencies during building phase with `--no-interaction --no-progress --no-scripts --no-dev` flags. To override the base flags (`--no-interaction --no-progress --no-scripts`), set the `CC_PHP_COMPOSER_FLAGS` environment variable. | ||||||
|
Check notice on line 56 in content/doc/applications/frankenphp.md
|
||||||
|
|
||||||
| To install development dependencies, set the `CC_PHP_DEV_DEPENDENCIES` environment variable to `install`. | ||||||
| To install development dependencies, set the `CC_PHP_DEV_DEPENDENCIES` environment variable to `install`. This removes the `--no-dev` flag independently of `CC_PHP_COMPOSER_FLAGS`. | ||||||
|
|
||||||
| > [!TIP] Use a local Composer version | ||||||
| > If you put a `composer.phar` file at the root of your project, it will be used to install dependencies. | ||||||
|
|
@@ -73,23 +73,31 @@ | |||||
| - [Learn more about Materia KV](/doc/addons/materia-kv) | ||||||
| - [Materia KV and FrankenPHP demo](https://github.com/CleverCloud/frankenphp-kv-json-example) | ||||||
|
|
||||||
| ### Worker mode | ||||||
| ## Worker mode | ||||||
|
|
||||||
| With FrankenPHP worker mode, a script of your project is kept in memory to handle incoming requests in a few milliseconds. Define the path to this script, relative to the root of your project, with the `CC_FRANKENPHP_WORKER` environment variable (e.g. `/worker/script.php`). It's supported by design by Laravel Octane and Symfony Runtime projects. | ||||||
| With FrankenPHP worker mode, a script of your project is kept in memory to handle incoming requests in a few milliseconds. Define the path to this script, relative to the root of your project, with the `CC_FRANKENPHP_WORKER` environment variable (e.g. `/public/worker.php`). The worker script must be located within the webroot directory. It's supported by design by Laravel Octane and Symfony Runtime projects. | ||||||
|
Check notice on line 78 in content/doc/applications/frankenphp.md
|
||||||
|
||||||
| With FrankenPHP worker mode, a script of your project is kept in memory to handle incoming requests in a few milliseconds. Define the path to this script, relative to the root of your project, with the `CC_FRANKENPHP_WORKER` environment variable (e.g. `/public/worker.php`). The worker script must be located within the webroot directory. It's supported by design by Laravel Octane and Symfony Runtime projects. | |
| With FrankenPHP worker mode, a script of your project is kept in memory to handle incoming requests in a few milliseconds. Define the path to this script, relative to the webroot directory of your project (for example `public/worker.php`), with the `CC_FRANKENPHP_WORKER` environment variable. It's supported by design by Laravel Octane and Symfony Runtime projects. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The removal of the "push on the master branch" requirement is appropriate as modern Git workflows may use different default branch names (main, etc.). However, ensure that the deployment documentation elsewhere clearly explains which branch is used for deployment, or that the platform automatically detects the default branch.