NGINX Unit
v. 1.21.0

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. Set installation path permissions to secure access, for example:

    # chown -R app_user:app_group /path/to/app/
    

    Update the placeholders above with actual values, noting them for later use in Unit configuration.

  4. Finally, prepare and upload the app configuration to Unit (note the use of uri, share, and fallback):

    {
        "listeners": {
            "*:80": {
                "pass": "routes/cakephp"
            }
        },
    
        "routes": {
            "cakephp": [
                {
                    "match": {
                        "uri": [
                            "*.php",
                            "*.php/*"
                        ]
                    },
    
                    "action": {
                        "pass": "applications/cakephp/direct"
                    }
                },
                {
                    "action": {
                        "share": "/path/to/app/webroot/",
                        "fallback": {
                            "pass": "applications/cakephp/index"
                        }
                    }
                }
            ]
        },
    
        "applications": {
            "cakephp": {
                "type": "php",
                "user": "app_user",
                "group": "app_group",
                "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 --help or see Startup for details.

    CakePHP Basic Template App on Unit