Platform.sh User Documentation

Laravel Octane

Back to home

On this page

Upsun Beta

Access our newest offering - Upsun!

Get your free trial by clicking the link below.

Get your Upsun free trial

Laravel Octane aims at improving the performance of Laravel applications by serving them using high-powered application servers, including Swoole, Open Swoole, and RoadRunner.

Install Anchor to this heading

Install the PHP extension for Swoole or Open Swoole during the build.

Take advantage of an installation script. You need to pass 2 parameters:

  • Which Swoole project to use: openswoole or swoole
  • Which version to install
.platform.app.yaml
hooks:
    build: |
        set -e
        ...
        curl -fsS https://raw.githubusercontent.com/platformsh/snippets/main/src/install_swoole.sh | { bash /dev/fd/3 openswoole 4.11.0 ; } 3<&0        

Use Anchor to this heading

Require Laravel Octane using Composer.

composer require laravel/octane

Then make sure to clear the cache on all relevant Platform.sh environments.

php artisan optimize:clear

Override the default web server with a custom start command. Octane should listen on a TCP socket.

.platform.app.yaml
web:
    upstream:
        socket_family: tcp
        protocol: http
    commands:
        start: php artisan octane:start --server=swoole --host=0.0.0.0 --port=$PORT
    locations:
        "/":
            passthru: true
            scripts: false
            allow: false

Is this page helpful?