Frankenphp documentation (#396)

Author: ioaniftimesei

README.md

@@ -67,8 +67,8 @@ You can run on Debian 10, by doing this setup before install: [Debian10 setup](.
 #### Deployment setup
 - [Caddy & PHP-FPM](./docs/caddy-php-fpm.md)
 - [Apache mod_php](./docs/apache-mod-php.md)
-- [FrannkenPHP classic](./docs/caddy-frankenphp-classic.md)
-- [FrannkenPHP worker](./docs/caddy-frankenphp-worker.md)
+- [FrankenPHP classic](./docs/frankenphp-classic.md)
+- [FrankenPHP worker](./docs/frankenphp-worker.md)
 
 #### Managed platforms
 - [Laravel Forge](./docs/laravel-forge.md)

docs/frankenphp-classic.md

@@ -0,0 +1,23 @@
+# FrankenPHP (Classic Mode)
+
+1. Pass the Aikido environment variables in your `Caddyfile`
+
+`Caddyfile`
+```
+example.com {
+    root * /var/www/html/public
+
+    php_server {
+        env AIKIDO_TOKEN "AIK_RUNTIME_...."
+        env AIKIDO_BLOCK "True"
+    }
+
+    file_server
+}
+```
+
+You can get your token from the [Aikido Security Dashboard](https://help.aikido.dev/doc/creating-an-aikido-zen-firewall-token/doc6vRJNzC4u).
+
+2. Start FrankenPHP
+
+`frankenphp run --config Caddyfile`

docs/frankenphp-worker.md

@@ -0,0 +1,48 @@
+# FrankenPHP (Worker Mode)
+
+1. Pass the Aikido environment variables to FrankenPHP in your `Caddyfile` and configure the worker
+
+`Caddyfile`
+```
+example.com {
+    root * /var/www/html/public
+
+    php_server {
+        env AIKIDO_TOKEN "AIK_RUNTIME_...."
+        env AIKIDO_BLOCK "True"
+        worker {
+          // your worker parameters
+        }
+    }
+
+    file_server
+}
+```
+
+You can get your token from the [Aikido Security Dashboard](https://help.aikido.dev/doc/creating-an-aikido-zen-firewall-token/doc6vRJNzC4u).
+
+2. Call `\aikido\worker_rinit()` and `\aikido\worker_rshutdown()` in your worker script
+
+Wrap your request handler with these calls to ensure Aikido processes each request.
+
+`public/index.php`
+```php
+<?php
+
+require __DIR__ . '/../vendor/autoload.php';
+$app = require_once __DIR__ . '/../bootstrap/app.php';
+
+while (frankenphp_handle_request(function () use ($app) {
+    \aikido\worker_rinit();
+
+    // Your application logic
+    
+    \aikido\worker_rshutdown();
+})) {
+    // keep looping
+}
+```
+
+3. Start FrankenPHP
+
+`frankenphp run --config Caddyfile`