CakePHP§

To run apps based on the CakePHP framework using Unit:

1. Install Unit with a PHP 7.2+ language module.

2. Install CakePHP and create or deploy your app. Here, we use CakePHP’s basic template and Composer:

   $ cd /path/to/
   $ composer create-project --prefer-dist cakephp/app:4.* app
   

   This creates the app’s directory tree at /path/to/app/. Its webroot/ subdirectory contains both the root index.php and the static files; if your app requires additional .php scripts, also store them here.

3. Run the following command so Unit can access the application directory:

   # chown -R unit:unit /path/to/app/
   

   Note

   The unit:unit user-group pair is available only with official packages, Docker images, and some third-party repos. Otherwise, account names may differ; run the ps aux | grep unitd command to be sure.

   For further details, including permissions, see the security checklist.

4. Next, prepare the app configuration for Unit (use real values for share and root):

   {
       "listeners": {
           "*:80": {
               "pass": "routes"
           }
       },
   
       "routes": [
           {
               "match": {
                   "uri": [
                       "*.php",
                       "*.php/*"
                   ]
               },
   
               "action": {
                   "pass": "applications/cakephp/direct"
               }
           },
           {
               "action": {
                   "share": "/path/to/app/webroot$uri",
                   "fallback": {
                       "pass": "applications/cakephp/index"
                   }
               }
           }
       ],
   
       "applications": {
           "cakephp": {
               "type": "php",
               "targets": {
                   "direct": {
                       "root": "/path/to/app/webroot/"
                   },
   
                   "index": {
                       "root": "/path/to/app/webroot/",
                       "script": "index.php"
                   }
               }
           }
       }
   }
   

   Note

   The difference between the pass targets is their usage of the script setting:

   • The direct target runs the .php script from the URI or defaults to index.php if the URI omits it.

   • The index target specifies the script that Unit runs for any URIs the target receives.

   For a detailed discussion, see Fire It Up in CakePHP docs.

5. Upload the updated configuration. Assuming the JSON above was added to config.json:

   # curl -X PUT --data-binary @config.json --unix-socket \
          /path/to/control.unit.sock http://localhost/config/
   

   Note

   The control socket path may vary; run unitd -h or see Startup and Shutdown for details.

   After a successful update, your app should be available on the listener’s IP address and port: