Matomo

To run the Matomo web analytics platform using Unit:

1. Install Unit with a PHP language module.

2. Install and configure Matomo’s prerequisites

3. Install Matomo’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 Matomo configuration for Unit (use real values for share and root). The default .htaccess scheme in a Matomo installation roughly translates into the following:

   json

   Copy

   {
      "listeners": {
         "*:80": {
               "pass": "routes"
         }
      },
   
      "routes": [
         {
               "match": {
                  "uri": [
                     "/index.php",
                     "/js/index.php",
                     "/matomo.php",
                     "/misc/cron/archive.php",
                     "/piwik.php",
                     "/plugins/HeatmapSessionRecording/configs.php"
                  ]
               },
               "_comment_match": "Handles all PHP scripts that should be public",
               "action": {
                  "pass": "applications/matomo/direct"
               }
         },
         {
               "match": {
                  "uri": [
                     "*.php",
                     "*/.htaccess",
                     "/config/*",
                     "/core/*",
                     "/lang/*",
                     "/tmp/*"
                  ]
               },
               "_comment_match": "Denies access to files and directories best kept private, including internal PHP scripts",
               "action": {
                  "return": 404
               }
         },
         {
               "match": {
                  "uri": "~\\.(css|gif|html?|ico|jpg|js(on)?|png|svg|ttf|woff2?)$"
               },
               "_comment_match": "Enables access to static content only",
               "action": {
                  "share": "/path/to/app$uri"
               },
               "_comment_action": "Serves matching static files"
         },
         {
               "match": {
                  "uri": [
                     "!/libs/*",
                     "!/node_modules/*",
                     "!/plugins/*",
                     "!/vendor/*",
                     "!/misc/cron/*",
                     "!/misc/user/*"
                  ]
               },
               "_comment_match": "Disables access to certain directories that may nonetheless contain public-facing static content served by the previous rule; forwards all unhandled requests to index.php in the root directory",
               "action": {
                  "share": "/path/to/app$uri",
                  "_comment_action": "Serves remaining static files",
                  "fallback": {
                     "pass": "applications/matomo/index"
                  },
                  "_comment_fallback": "A catch-all destination for the remaining requests"
               }
         }
      ],
   
      "applications": {
         "matomo": {
               "type": "php",
               "targets": {
                  "direct": {
                     "root": "/path/to/app/"
                  },
                  "_comment_direct": "Path to the application directory; use a real path in your configuration",
                  "index": {
                     "root": "/path/to/app/",
                     "script": "index.php"
                  },
                  "_comment_index": "All requests are handled by a single script"
               }
         }
      }
   }

   {
      "listeners": {
         "*:80": {
               "pass": "routes"
         }
      },
   
      "routes": [
         {
               "match": {
                  "uri": [
                     "/index.php",
                     "/js/index.php",
                     "/matomo.php",
                     "/misc/cron/archive.php",
                     "/piwik.php",
                     "/plugins/HeatmapSessionRecording/configs.php"
                  ]
               },
               "_comment_match": "Handles all PHP scripts that should be public",
               "action": {
                  "pass": "applications/matomo/direct"
               }
         },
         {
               "match": {
                  "uri": [
                     "*.php",
                     "*/.htaccess",
                     "/config/*",
                     "/core/*",
                     "/lang/*",
                     "/tmp/*"
                  ]
               },
               "_comment_match": "Denies access to files and directories best kept private, including internal PHP scripts",
               "action": {
                  "return": 404
               }
         },
         {
               "match": {
                  "uri": "~\\.(css|gif|html?|ico|jpg|js(on)?|png|svg|ttf|woff2?)$"
               },
               "_comment_match": "Enables access to static content only",
               "action": {
                  "share": "/path/to/app$uri"
               },
               "_comment_action": "Serves matching static files"
         },
         {
               "match": {
                  "uri": [
                     "!/libs/*",
                     "!/node_modules/*",
                     "!/plugins/*",
                     "!/vendor/*",
                     "!/misc/cron/*",
                     "!/misc/user/*"
                  ]
               },
               "_comment_match": "Disables access to certain directories that may nonetheless contain public-facing static content served by the previous rule; forwards all unhandled requests to index.php in the root directory",
               "action": {
                  "share": "/path/to/app$uri",
                  "_comment_action": "Serves remaining static files",
                  "fallback": {
                     "pass": "applications/matomo/index"
                  },
                  "_comment_fallback": "A catch-all destination for the remaining requests"
               }
         }
      ],
   
      "applications": {
         "matomo": {
               "type": "php",
               "targets": {
                  "direct": {
                     "root": "/path/to/app/"
                  },
                  "_comment_direct": "Path to the application directory; use a real path in your configuration",
                  "index": {
                     "root": "/path/to/app/",
                     "script": "index.php"
                  },
                  "_comment_index": "All requests are handled by a single script"
               }
         }
      }
   }

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