Roundcube

To run the Roundcube webmail platform using Unit:

  1. Install Unit with a PHP language module.

  2. Install and configure Roundcube’s prerequisites

  3. Install Roundcube’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):

    # 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 Roundcube configuration for Unit (use real values for share and root):

    {
       "listeners": {
          "*:80": {
                "pass": "routes"
          }
       },
    
       "routes": [
          {
                "match": {
                   "uri": [
                      "*.php",
                      "*/"
                   ]
                },
                "_comment_match": "Serves direct requests for PHP scripts and directory-like URIs",
                "action": {
                   "pass": "applications/roundcube"
                }
          },
          {
                "action": {
                   "share": "/path/to/app$uri"
                },
                "_comment_action": "Serves static files"
          }
       ],
    
       "applications": {
          "roundcube": {
                "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:

    # 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, browse to http://localhost/installer/ and set up your Roundcube installation:

    Roundcube on Unit - Setup Screen

  7. After installation, switch share and root to the public_html/ subdirectory to protect sensitive data, run the following command as root:

    curl -X PUT -d '"/path/to/app/public_html$uri"' --unix-socket /path/to/control.unit.sock \
      http://localhost/config/routes/1/action/share
    
    curl -X PUT -d '"/path/to/app/public_html/"' --unix-socket /path/to/control.unit.sock \
      http://localhost/config/applications/roundcube/root
    

    Thus, Roundcube should be available on the listener’s IP address and port:

    Roundcube on Unit - Login Screen


Last modified February 6, 2025