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:

   console

   Copy

   $ cd /path/to/  # Path where the application directory will be created; use a real path in your configuration
   

   $ cd /path/to/  # Path where the application directory will be created; use a real path in your configuration
   

   console

   Copy

   $ composer create-project --prefer-dist cakephp/app:4.* app  # Arbitrary app name; becomes the application directory name
   

   $ composer create-project --prefer-dist cakephp/app:4.* app  # Arbitrary app name; becomes the application directory name
   

   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. Change ownership:

   Run the following command (as root) so Unit can access the application directory (If the application uses several directories, run the command for each one):

   console

   Copy

   # chown -R unit:unit /path/to/app/  # User and group that Unit's router runs as by default
      

   # chown -R unit:unit /path/to/app/  # User and group that Unit's router runs as by default
      

   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):

   json

   Copy

   {
   "listeners": {
      "*:80": {
         "pass": "routes"
      }
   },
   "routes": [
      {
         "match": {
         "uri": [
            "*.php",
            "*.php/*"
         ],
         "uri_comment": "The second element '*.php/*' handles all requests that explicitly target PHP scripts"
         },
         "action": {
         "pass": "applications/cakephp/direct"
         }
      },
      {
         "action": {
         "share": "/path/to/app/webroot$uri",
         "share_comment": "Unconditionally serves remaining requests that target static files",
         "fallback": {
            "pass": "applications/cakephp/index",
            "fallback_comment": "Serves any requests not served with the 'share' immediately above"
         }
         }
      }
   ],
   "applications": {
      "cakephp": {
         "type": "php",
         "targets": {
         "direct": {
            "root": "/path/to/app/webroot/",
            "root_comment": "Path to the webroot/ directory; use a real path in your configuration"
         },
         "index": {
            "root": "/path/to/app/webroot/",
            "root_comment": "Path to the webroot/ directory; use a real path in your configuration",
            "script": "index.php",
            "script_comment": "All requests are handled by a single script"
         }
         }
      }
   }
   }

   {
   "listeners": {
      "*:80": {
         "pass": "routes"
      }
   },
   "routes": [
      {
         "match": {
         "uri": [
            "*.php",
            "*.php/*"
         ],
         "uri_comment": "The second element '*.php/*' handles all requests that explicitly target PHP scripts"
         },
         "action": {
         "pass": "applications/cakephp/direct"
         }
      },
      {
         "action": {
         "share": "/path/to/app/webroot$uri",
         "share_comment": "Unconditionally serves remaining requests that target static files",
         "fallback": {
            "pass": "applications/cakephp/index",
            "fallback_comment": "Serves any requests not served with the 'share' immediately above"
         }
         }
      }
   ],
   "applications": {
      "cakephp": {
         "type": "php",
         "targets": {
         "direct": {
            "root": "/path/to/app/webroot/",
            "root_comment": "Path to the webroot/ directory; use a real path in your configuration"
         },
         "index": {
            "root": "/path/to/app/webroot/",
            "root_comment": "Path to the webroot/ directory; use a real path in your configuration",
            "script": "index.php",
            "script_comment": "All requests are handled by a single script"
         }
         }
      }
   }
   }

   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. Run the following command as root:

   console

   Copy

   # curl -X PUT --data-binary @config.json --unix-socket \
         /path/to/control.unit.sock \  # Path to Unit's control socket in your installation
         http://localhost/config/      # Path to the config section in Unit's control API
      

   # curl -X PUT --data-binary @config.json --unix-socket \
         /path/to/control.unit.sock \  # Path to Unit's control socket in your installation
         http://localhost/config/      # Path to the config section in Unit's control API
      

   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: