NGINX Unit
v. 1.22.0

MODX§

To run the MODX content application platform using Unit:

  1. Install Unit with a PHP language module.

  2. Install and configure MODX’s prerequisites.

  3. Install MODX’s core files. Here, we install it at /path/to/app/; use a real path in your configuration.

  4. Run the following command for each directory containing app code or data so Unit can access it:

    # 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.

  5. Next, prepare the MODX configuration for Unit (use real values for share and root). The default .htaccess scheme in a MODX installation roughly translates into the following:

    {
        "listeners": {
            "*:80": {
                "pass": "routes/modx"
            }
        },
    
        "routes": {
            "modx": [
                {
                    "match": {
                        "uri": [
                            "!/.well-known/",
                            "/core/*",
                            "*/.*"
                        ]
                    },
    
                    "action": {
                        "return": 404
                    }
                },
                {
                    "match": {
                        "uri": "*.php"
                    },
    
                    "action": {
                        "pass": "applications/modx"
                    }
                },
                {
                    "action": {
                        "share": "/path/to/app/",
                        "fallback": {
                            "pass": "applications/modx"
                        }
                    }
                }
            ]
        },
    
        "applications": {
            "modx": {
                "type": "php",
                "root": "/path/to/app/"
            }
        }
    }
    
  6. 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 and Shutdown for details.

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

    MODX on Unit - Manager Screen