README.md

Laravel Octane Dockerfile

Production-ready Dockerfiles for Laravel Octane powered web services and microservices.

The Docker configuration provides the following setup:

• PHP 8.2 and 8.3 official Debian-based and Alpine-based images
• Preconfigured JIT compiler and OPcache

Container modes

You can run the Docker container in different modes:

Mode	CONTAINER_MODE	HTTP server
HTTP Server (default)	http	FrankenPHP / Swoole / RoadRunner
Horizon	horizon	-
Scheduler	scheduler	-
Worker	worker	-

Usage

Building Docker image

1. Clone this repository:

git clone --depth 1 [email protected]:exaco/laravel-octane-dockerfile.git

2. Copy cloned directory content including deployment directory, Dockerfile, and .dockerignore into your Octane powered Laravel project
3. Change the directory to your Laravel project
4. Build your image:

docker build -t <image-name>:<tag> -f <your-octane-driver>.Dockerfile .

Running Docker container

# HTTP mode
docker run -p <port>:8000 --rm <image-name>:<tag>

# Horizon mode
docker run -e CONTAINER_MODE=horizon --rm <image-name>:<tag>

# Scheduler mode
docker run -e CONTAINER_MODE=scheduler --rm <image-name>:<tag>

# HTTP mode with Horizon
docker run -e WITH_HORIZON=true -p <port>:8000 --rm <image-name>:<tag>

# HTTP mode with Scheduler
docker run -e WITH_SCHEDULER=true -p <port>:8000 --rm <image-name>:<tag>

# HTTP mode with Scheduler and Horizon
docker run -e WITH_SCHEDULER=true -e WITH_HORIZON=true -p <port>:8000 --rm <image-name>:<tag>

# Worker mode
docker run -e CONTAINER_MODE=worker -e WORKER_COMMAND="php /var/www/html/artisan foo:bar" --rm <image-name>:<tag>

# Running a single command
docker run --rm <image-name>:<tag> php artisan about

Configuration

Recommended Swoole options in octane.php

// config/octane.php

return [
    'swoole' => [
        'options' => [
            'http_compression' => true,
            'http_compression_level' => 6, // 1 - 9
            'compression_min_length' => 20,
            'package_max_length' => 20 * 1024 * 1024, // 20MB
            'open_http2_protocol' => true,
            'document_root' => public_path(),
            'enable_static_handler' => true,
        ]
    ]
];

Utilities

Also, some useful Bash functions and aliases are added in utilities.sh that maybe help.

Notes

• Laravel Octane logs request information only in the local environment.
• Please be aware of .dockerignore content

ToDo

• Add support for PHP 8.3
• Add support for worker mode
• Build assets with Bun
• Create standalone and self-executable app
• Add support for Horizon
• Add support for RoadRunner
• Add support for FrankenPHP
• Add support for Laravel Reverb
• Add support for the full-stack apps (Front-end assets)
• Add support testing environment and CI
• Add support for the Laravel scheduler
• Add support for Laravel Dusk
• Support more PHP extensions
• Add tests
• Add Alpine-based images

Contributing

Thank you for considering contributing! If you find an issue, or have a better way to do something, feel free to open an issue, or a PR.

Credits

• SMortexa
• All contributors

License

This repository is open-sourced software licensed under the MIT license.