#

Custom Drivers

You can extend Herd with your own drivers to support custom setups of supported frameworks or to add new frameworks that Herd doesn't support out of the box.

Herd internally leverages a version of Laravel Valet for serving sites and includes all drivers that Valet provides. These drivers are a good start when creating your own custom driver, and it often makes sense to extend them than starting from scratch.

Place your custom driver in the related valet directory on your machine and Herd loads it automatically.

~/Library/Application Support/Herd/config/valet/Drivers

#

Customize Herds behaviour

Log paths

You can customize the paths that are checked for the log viewer by adjusting the logFilesPaths() method in the driver. The default looks like this:

/**
 * Get the logs paths for the application to show in Herds log viewer.
 */
public function logFilesPaths() {
    return ["/storage/logs"];
}

The given paths are relative to the application root.

Application Information

The tabular overview shown in the information tab in the sites overview is also customizable. The default of a compatible Laravel app is the output of the php artisan about command.

If you want to customize the overview table, you can do so by defining this method in your applications' custom driver and returning an array like the following:

public function siteInformation(string $sitePath, string $phpBinary): array
{
    return [
        "Overview" => [
            "Site Name" => "Laravel Airport",
            "Runway operational" => true,
        ],
        "Flights" => [
            "Today" => 10,
            "Yesterday" => 5,
            "This week" => 22,
        ],
    ];
}

The sites' path and the path to the PHP binary are also available in case you want to perform specific commands to get more information.

#

Custom Laravel Driver

This example of a custom driver extends the existing Laravel Driver and modifies it to serve the application from a web instead of the public directory.

 
namespace Valet\Drivers\Custom;
 
use Valet\Drivers\LaravelValetDriver;
 
class CustomLaravelValetDriver extends LaravelValetDriver
{
    /**
     * Determine if the driver serves the request.
     */
    public function serves(string $sitePath, string $siteName, string $uri): bool
    {
        return file_exists($sitePath.'/web/index.php') &&
               file_exists($sitePath.'/artisan');
    }
 
    /**
     * Determine if the incoming request is for a static file.
     */
    public function isStaticFile(string $sitePath, string $siteName, string $uri)/*: string|false */
    {
        if (file_exists($staticFilePath = $sitePath.'/web'.$uri)
           && is_file($staticFilePath)) {
            return $staticFilePath;
        }
 
        $storageUri = $uri;
 
        if (strpos($uri, '/storage/') === 0) {
            $storageUri = substr($uri, 8);
        }
 
        if ($this->isActualFile($storagePath = $sitePath.'/storage/app/public'.$storageUri)) {
            return $storagePath;
        }
 
        return false;
    }
 
    /**
     * Get the fully resolved path to the application's front controller.
     */
    public function frontControllerPath(string $sitePath, string $siteName, string $uri): ?string
    {
        if (file_exists($staticFilePath = $sitePath.'/web'.$uri)
           && $this->isActualFile($staticFilePath)) {
            return $staticFilePath;
        }
 
        return $sitePath.'/web/index.php';
    }
 
        /**
     * Get the logs paths for the application to show in Herds log viewer.
     */
    public function logFilesPaths() {
        return ["/storage/logs"];
    }
 
    /**
     * Display information about the application in the information tab of the Sites UI.
     * For Laravel, it's the output of the `php artisan about` command.
     */
    public function siteInformation(string $sitePath, string $phpBinary): array
    {
        try {
            $process = new Process([
                $phpBinary,
                'artisan',
                'about',
                '--json'
            ], $sitePath);
 
            $process->mustRun();
 
            $result = json_decode($process->getOutput(), true);
        } catch (\Exception $e) {
            $result = [];
        }
 
        return [
            ...$result,
        ];
    }
}