Customize PHP runtime environment

Build Custom Runtime Images

Zerops allows you to build custom runtime images (CRI) when the default base runtime images don't meet your PHP application's requirements. This is an optional phase in the build and deploy pipeline.

Configuration

Default PHP Runtime Environment

The default PHP runtime environment contains:

• Alpine Linux
• Selected version of PHP when the runtime service was created
• zCLI
• Git and Composer

When You Need a Custom Runtime Image

If your PHP application needs more than what's included in the default environment, you'll need to build a custom runtime image. Common scenarios include:

• System packages for processing: When your app processes images, videos, or files (requiring packages like sudo apk add --no-cache imagemagick)
• PHP extensions: When you need additional PHP extensions not included by default
• Native dependencies: When your Composer packages require system libraries that aren't in the default environment
• Different base OS: When you need Ubuntu instead of Alpine for specific compatibility requirements

important

You should not include your application code in the custom runtime image, as your built/packaged code is deployed automatically into fresh containers.

Here are PHP-specific examples of configuring custom runtime images in your zerops.yml:

Basic PHP Setup

run:
os: ubuntu
base: php-apache@8.5
prepareCommands:
  - sudo apt-get install -y imagemagick
  - composer global require some/package

Using Build Files in Runtime Preparation

build:
addToRunPrepare:
  - composer.json
  - composer.lock
run:
prepareCommands:
  - sudo apk add --no-cache imagemagick
  - sudo apk add --no-cache ffmpeg
  - composer install --no-dev

For complete configuration details, see the runtime prepare phase configuration guide.

Process and Caching

How Runtime Prepare Works

The runtime prepare process follows the same steps for all runtimes. See how runtime prepare works for the complete process details.

Caching Behavior

Zerops caches custom runtime images to optimize deployment times. Learn about custom runtime image caching including when images are cached and reused.

Build Management

For information about managing builds and deployments, see managing builds and deployments.

Warning

Local Storage volumes are not available during the runtime prepare phase, and start commands (such as a SeaweedFS mount) do not run there.

Troubleshooting

If your prepareCommands fail, check the prepare runtime log for specific error messages.

Overwrite php.ini files

You can override PHP configuration directives by setting environment variables in your zerops.yaml file.

Here's an example of how to adjust PHP's post_max_size directive:

zerops:
  # define hostname of your service
  - setup: app
    # ==== how to run your application ====
    run:
      # REQUIRED. Sets the base technology for the runtime environment:
      base: php-nginx@8.3

      # OPTIONAL. Defines the env variables for the runtime:
      envVariables:
        PHP_INI_post_max_size: 10M

Info

After updating PHP-FPM configuration in your zerops.yaml file, you need to restart or reload the app for the changes to take effect.

PHP-FPM

Default PHP-FPM configuration

PHP-FPM (FastCGI Process Manager) uses the dynamic process management mode by default. In this mode, the system automatically adjusts the number of PHP processes based on current load.

The default PHP-FPM configuration uses these values:

• PHP_FPM_PM = dynamic
• PHP_FPM_PM_MAX_CHILDREN = 20
• PHP_FPM_PM_START_SERVERS = 2
• PHP_FPM_PM_MIN_SPARE_SERVERS = 1
• PHP_FPM_PM_MAX_SPARE_SERVERS = 3
• PHP_FPM_PM_MAX_SPAWN_RATE = 32
• PHP_FPM_PM_MAX_REQUESTS = 500

Dynamic mode

To adjust the dynamic mode settings, add the desired environment variables to the run section:

zerops:
  # define hostname of your service
  - setup: app
    # ==== how to run your application ====
    run:
      # OPTIONAL. Defines the env variables for the runtime:
      envVariables:
        PHP_FPM_PM_MAX_CHILDREN: 30
        PHP_FPM_PM_START_SERVERS: 5
        PHP_FPM_PM_MIN_SPARE_SERVERS: 2
        PHP_FPM_PM_MAX_SPARE_SERVERS: 10
        PHP_FPM_PM_MAX_REQUESTS: 1000

Ondemand mode

The ondemand mode is ideal for applications with lower traffic, where processes are created only when requests arrive. To enable ondemand mode:

zerops:
  # define hostname of your service
  - setup: app
    # ==== how to run your application ====
    run:
      # OPTIONAL. Defines the env variables for the runtime:
      envVariables:
        PHP_FPM_PM: ondemand
        PHP_FPM_PM_MAX_CHILDREN: 20
        PHP_FPM_PM_PROCESS_IDLE_TIMEOUT: 60s
        PHP_FPM_PM_MAX_REQUESTS: 500

Available parameters for ondemand mode:

• PHP_FPM_PM_MAX_CHILDREN – maximum number of child processes
• PHP_FPM_PM_PROCESS_IDLE_TIMEOUT – time after which idle processes are terminated (default: 60s)
• PHP_FPM_PM_MAX_REQUESTS – number of requests each process handles before being recycled (default: 500)

Info

After updating PHP-FPM configuration in your zerops.yaml file, you need to restart or reload the app for the changes to take effect.