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 them at /path/to/app; use a real path in your configuration.

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

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:

   json

   Copy

   {
      "listeners": {
         "*:80": {
               "pass": "routes"
         }
      },
   
      "routes": [
         {
               "match": {
                  "uri": [
                     "!/.well-known/",
                     "/core/*",
                     "*/.*"
                  ]
               },
               "_comment_match": "Denies access to directories best kept private",
               "action": {
                  "return": 404
               }
         },
         {
               "match": {
                  "uri": "*.php"
               },
               "_comment_match": "Serves direct requests for PHP scripts",
               "action": {
                  "pass": "applications/modx"
               }
         },
         {
               "action": {
                  "share": "/path/to/app$uri",
                  "_comment_share": "Serves static files",
                  "fallback": {
                     "pass": "applications/modx"
                  },
                  "_comment_fallback": "A catch-all destination for the remaining requests"
               }
         }
      ],
   
      "applications": {
         "modx": {
               "type": "php",
               "root": "/path/to/app/",
               "_comment_root": "Path to the application directory; use a real path in your configuration"
         }
      }
   }

   {
      "listeners": {
         "*:80": {
               "pass": "routes"
         }
      },
   
      "routes": [
         {
               "match": {
                  "uri": [
                     "!/.well-known/",
                     "/core/*",
                     "*/.*"
                  ]
               },
               "_comment_match": "Denies access to directories best kept private",
               "action": {
                  "return": 404
               }
         },
         {
               "match": {
                  "uri": "*.php"
               },
               "_comment_match": "Serves direct requests for PHP scripts",
               "action": {
                  "pass": "applications/modx"
               }
         },
         {
               "action": {
                  "share": "/path/to/app$uri",
                  "_comment_share": "Serves static files",
                  "fallback": {
                     "pass": "applications/modx"
                  },
                  "_comment_fallback": "A catch-all destination for the remaining requests"
               }
         }
      ],
   
      "applications": {
         "modx": {
               "type": "php",
               "root": "/path/to/app/",
               "_comment_root": "Path to the application directory; use a real path in your configuration"
         }
      }
   }

6. 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, MODX should be available on the listener’s IP address and port: