Laravel

To run apps based on the Laravel framework using Unit:

  1. Install Unit with a PHP language module.

  2. Install and configure Laravel’s prerequisites.

  3. Create a Laravel project. For our purposes, the path is /path/to/app/:

    $ cd /path/to/ #Path where the application directory will be created; use a real path in your configuration
    
    $ composer create-project laravel/laravel `app` #Arbitrary app name; becomes the application directory name
    
  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.

    See the Laravel docs for further details on directory structure.
  5. Next, prepare the Laravel configuration for Unit (use real values for share and root):

    {
       "listeners": {
          "*:80": {
             "pass": "routes"
          }
       },
       "routes": [
          {
             "match": {
             "uri": "!/index.php",
             "uri_comment": "Denies access to index.php as a static file"
             },
             "action": {
             "share": "/path/to/app/public$uri",
             "share_comment": "Serves static files",
             "fallback": {
                "pass": "applications/laravel",
                "pass_comment": "Uses the index.php at the root as the last resort"
             }
             }
          }
       ],
       "applications": {
          "laravel": {
             "type": "php",
             "root": "/path/to/app/public/",
             "root_comment": "Path to the application directory; use a real path in your configuration",
             "script": "index.php",
             "script_comment": "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:

    # 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 and set up your Laravel application:

    Laravel on Unit - Sample Screen


Last modified February 6, 2025