phpBB

To run the phpBB bulletin board using Unit:

1. Install Unit with a PHP language module.

2. Install and configure phpBB’s prerequisites

3. Install phpBB’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

   Copy

   # chown -R unit:unit /path/to/app/  # User and group that Unit's router runs as by default
      

   Copy

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

   json

   Copy

   Copy

   {
      "listeners": {
         "*:80": {
               "pass": "routes"
         }
      },
   
      "routes": [
         {
               "match": {
                  "uri": [
                     "/cache/*",
                     "/common.php*",
                     "/config.php*",
                     "/config/*",
                     "/db/migration/data/*",
                     "/files/*",
                     "/images/avatars/upload/*",
                     "/includes/*",
                     "/store/*"
                  ]
               },
               "_comment_match": "Denies access to files and directories best kept private",
               "action": {
                  "return": 404
               }
         },
         {
               "match": {
                  "uri": [
                     "/",
                     "*.php",
                     "*.php/*"
                  ]
               },
               "action": {
                  "pass": "applications/phpbb/direct"
               }
         },
         {
               "action": {
                  "share": "/path/to/app$uri",
                  "_comment_share": "Serves static files",
                  "fallback": {
                     "pass": "applications/phpbb/index"
                  },
                  "_comment_fallback": "Catch-all for requests not yet served by other rules"
               }
         }
      ],
   
      "applications": {
         "phpbb": {
               "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": "app.php"
                  },
                  "_comment_index": "Path to the application directory; use a real path in your configuration"
               }
         }
      }
   }

   Copy

   {
      "listeners": {
         "*:80": {
               "pass": "routes"
         }
      },
   
      "routes": [
         {
               "match": {
                  "uri": [
                     "/cache/*",
                     "/common.php*",
                     "/config.php*",
                     "/config/*",
                     "/db/migration/data/*",
                     "/files/*",
                     "/images/avatars/upload/*",
                     "/includes/*",
                     "/store/*"
                  ]
               },
               "_comment_match": "Denies access to files and directories best kept private",
               "action": {
                  "return": 404
               }
         },
         {
               "match": {
                  "uri": [
                     "/",
                     "*.php",
                     "*.php/*"
                  ]
               },
               "action": {
                  "pass": "applications/phpbb/direct"
               }
         },
         {
               "action": {
                  "share": "/path/to/app$uri",
                  "_comment_share": "Serves static files",
                  "fallback": {
                     "pass": "applications/phpbb/index"
                  },
                  "_comment_fallback": "Catch-all for requests not yet served by other rules"
               }
         }
      ],
   
      "applications": {
         "phpbb": {
               "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": "app.php"
                  },
                  "_comment_index": "Path to the application directory; use a real path in your configuration"
               }
         }
      }
   }

   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.

6. Upload the updated configuration.

   Assuming the JSON above was added to config.json. Run the following command as root:

   console

   Copy

   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
      

   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
      

   The control socket path may vary; run unitd -h or see Startup and shutdown for details.

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

   

7. Browse to /install/app.php to complete your installation. Having done that, delete the install/ subdirectory to mitigate security risks:

   console

   Copy

   Copy

   rm -rf /path/to/app/install/  # Path to the application directory; use a real path in your configuration
   

   Copy

   rm -rf /path/to/app/install/  # Path to the application directory; use a real path in your configuration