Skip to content

Commit

Permalink
Added Laravel Octane Documentation (#422)
Browse files Browse the repository at this point in the history
* Added Laravel Octane Documentation

* fixed lint

---------

Co-authored-by: Emre Çalışkan <emre.caliskan@beyn.com.tr>
  • Loading branch information
thecaliskan and Emre Çalışkan authored Dec 20, 2023
1 parent 47ada94 commit f6873ef
Show file tree
Hide file tree
Showing 2 changed files with 35 additions and 2 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ FrankenPHP is a modern application server for PHP built on top of the [Caddy](ht

FrankenPHP gives superpowers to your PHP apps thanks to its stunning features: [*Early Hints*](https://frankenphp.dev/docs/early-hints/), [worker mode](https://frankenphp.dev/docs/worker/), [real-time capabilities](https://frankenphp.dev/docs/mercure/), automatic HTTPS, HTTP/2, and HTTP/3 support...

FrankenPHP works with any PHP app and makes your Symfony projects faster than ever thanks to the provided integration with the worker mode (Laravel Octane support coming).
FrankenPHP works with any PHP app and makes your Symfony and Laravel projects faster than ever thanks to the provided integration with the worker mode.

FrankenPHP can also be used as a standalone Go library to embed PHP in any app using `net/http`.

Expand Down
35 changes: 34 additions & 1 deletion docs/laravel.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,4 +43,37 @@ Alternatively, you can run your Laravel projects with FrankenPHP from your local
## Laravel Octane
See [this Pull Request](https://github.com/laravel/octane/pull/764).
Octane may be installed via the Composer package manager:
```console
composer require laravel/octane
```

After installing Octane, you may execute the `octane:install` Artisan command, which will install Octane's configuration file into your application:

```console
php artisan octane:install --server=frankenphp
```

The Octane server can be started via the `octane:start` Artisan command.

```console
php artisan octane:start

//Additional Parameter
{--server=frankenphp : The server that should be used to serve the application}
{--host=127.0.0.1 : The IP address the server should bind to}
{--port= : The port the server should be available on [default: "8000"]}
{--workers=auto : The number of workers that should be available to handle requests}
{--task-workers=auto : The number of task workers that should be available to handle tasks}
{--max-requests=500 : The number of requests to process before reloading the server}
{--caddyfile= : The path to the FrankenPHP Caddyfile file}
{--https : Enable HTTPS, HTTP/2, and HTTP/3, and automatically generate and renew certificates}
{--watch : Automatically reload the server when the application is modified}
{--poll : Use file system polling while watching in order to watch files over a network}
{--log-level= : Log messages at or above the specified log level}';
```

## Docs

* [Laravel Octane](https://laravel.com/docs/master/octane)

0 comments on commit f6873ef

Please sign in to comment.