Laravel Valet

• Introducción
• Instalación
  • Actualizando Valet
• Sirviendo Sitios
  • El Comando "Park"
  • El Comando "Link"
  • Asegurando Sitios Con TLS
  • Sirviendo un Sitio Predeterminado
  • Versiones de PHP por Sitio
• Compartiendo Sitios
  • Compartiendo Sitios en tu Red Local
• Variables de Entorno Específicas del Sitio
• Servicios de Proxy
• Controladores Valet Personalizados
  • Controladores Locales
• Otros Comandos de Valet
• Directorios y Archivos de Valet
  • Acceso a Disco

Introducción

[!NOTE] ¿Buscas una forma aún más fácil de desarrollar aplicaciones Laravel en macOS o Windows? Echa un vistazo a Laravel Herd. Herd incluye todo lo que necesitas para comenzar con el desarrollo de Laravel, incluyendo Valet, PHP y Composer. Laravel Valet es un entorno de desarrollo para minimalistas de macOS. Laravel Valet configura tu Mac para que siempre ejecute Nginx en segundo plano cuando arranca tu máquina. Luego, usando DnsMasq, Valet proxy todas las solicitudes en el dominio *.test para que apunten a los sitios instalados en tu máquina local. En otras palabras, Valet es un entorno de desarrollo de Laravel ultrarrápido que utiliza aproximadamente 7 MB de RAM. Valet no es un reemplazo completo para Sail o Homestead, pero ofrece una gran alternativa si deseas aspectos básicos flexibles, prefieres una velocidad extrema o estás trabajando en una máquina con una cantidad limitada de RAM. Out of the box, el soporte de Valet incluye, pero no se limita a:

Sin embargo, puedes extender Valet con tus propios [controladores personalizados](#custom-valet-drivers).

Instalación

[!WARNING] Valet requiere macOS y Homebrew. Antes de la instalación, debes asegurarte de que no otros programas como Apache o Nginx estén vinculando al puerto 80 de tu máquina local. Para comenzar, primero necesitas asegurarte de que Homebrew esté actualizado utilizando el comando update:

brew update

A continuación, deberías usar Homebrew para instalar PHP:

brew install php

Después de instalar PHP, estás listo para instalar el gestor de paquetes Composer. Además, debes asegurarte de que el directorio $HOME/.composer/vendor/bin esté en el "PATH" de tu sistema. Después de que se haya instalado Composer, puedes instalar Laravel Valet como un paquete global de Composer:

composer global require laravel/valet

Finalmente, puedes ejecutar el comando install de Valet. Esto configurará e instalará Valet y DnsMasq. Además, los demonios de los que depende Valet se configurarán para que se inicien cuando arranque tu sistema:

valet install

Una vez que Valet esté instalado, intenta hacer ping a cualquier dominio *.test en tu terminal utilizando un comando como ping foobar.test. Si Valet está instalado correctamente, deberías ver este dominio respondiendo en 127.0.0.1. Valet iniciará automáticamente los servicios requeridos cada vez que arranque tu máquina.

Versiones de PHP

[!NOTA] En lugar de modificar tu versión global de PHP, puedes instruir a Valet para que use versiones de PHP por sitio a través del comando isolate command. Valet te permite cambiar las versiones de PHP utilizando el comando valet use php@version. Valet instalará la versión de PHP especificada a través de Homebrew si no está ya instalada:

valet use php@8.2
 
valet use php

También puedes crear un archivo .valetrc en la raíz de tu proyecto. El archivo .valetrc debe contener la versión de PHP que debe usar el sitio:

php=php@8.2

Una vez que se haya creado este archivo, simplemente puedes ejecutar el comando valet use y el comando determinará la versión de PHP preferida del sitio leyendo el archivo.

[!WARNING] Valet solo sirve una versión de PHP a la vez, incluso si tienes varias versiones de PHP instaladas.

Base de datos

Si tu aplicación necesita una base de datos, consulta DBngin, que ofrece una herramienta de gestión de bases de datos gratuita y todo en uno que incluye MySQL, PostgreSQL y Redis. Después de que se haya instalado DBngin, puedes conectarte a tu base de datos en 127.0.0.1 utilizando el nombre de usuario root y una cadena vacía para la contraseña.

Restableciendo tu instalación

Si tienes problemas para que tu instalación de Valet funcione correctamente, ejecutar el comando composer global require laravel/valet seguido de valet install reiniciará tu instalación y puede resolver una variedad de problemas. En casos raros, puede ser necesario "resetear" Valet de manera forzada ejecutando valet uninstall --force seguido de valet install.

Actualizando Valet

Puedes actualizar tu instalación de Valet ejecutando el comando composer global require laravel/valet en tu terminal. Después de la actualización, es una buena práctica ejecutar el comando valet install para que Valet pueda hacer actualizaciones adicionales a tus archivos de configuración si es necesario.

Actualizando a Valet 4

Si estás actualizando de Valet 3 a Valet 4, sigue los siguientes pasos para actualizar correctamente tu instalación de Valet:

Servir Sitios

Una vez que Valet está instalado, estás listo para comenzar a servir tus aplicaciones Laravel. Valet proporciona dos comandos para ayudarte a servir tus aplicaciones: park y link.

El comando park

El comando park registra un directorio en tu máquina que contiene tus aplicaciones. Una vez que el directorio ha sido "estacionado" con Valet, todos los directorios dentro de ese directorio serán accesibles en tu navegador web en http://<directory-name>.test:

cd ~/Sites
 
valet park

Eso es todo. Ahora, cualquier aplicación que crees dentro de tu directorio "parked" se servirá automáticamente utilizando la convención http://<directory-name>.test. Así que, si tu directorio parked contiene un directorio llamado "laravel", la aplicación dentro de ese directorio será accesible en http://laravel.test. Además, Valet te permite acceder al sitio utilizando subdominios comodín (http://foo.laravel.test).

El comando link

El comando link también se puede usar para servir tus aplicaciones Laravel. Este comando es útil si deseas servir un solo sitio en un directorio y no todo el directorio:

cd ~/Sites/laravel
 
valet link

Una vez que una aplicación ha sido vinculada a Valet utilizando el comando link, puedes acceder a la aplicación usando su nombre de directorio. Así que, el sitio que fue vinculado en el ejemplo anterior se puede acceder en http://laravel.test. Además, Valet te permite acceder automáticamente al sitio utilizando subdominios con comodín (http://foo.laravel.test). Si deseas servir la aplicación en un hostname diferente, puedes pasar el hostname al comando link. Por ejemplo, puedes ejecutar el siguiente comando para hacer que una aplicación esté disponible en http://application.test:

cd ~/Sites/laravel
 
valet link application

Por supuesto, también puedes servir aplicaciones en subdominios utilizando el comando link:

valet link api.application

Puedes ejecutar el comando links para mostrar una lista de todos tus directorios enlazados:

valet links

El comando unlink se puede usar para destruir el enlace simbólico de un sitio:

cd ~/Sites/laravel
 
valet unlink

Asegurando Sitios Con TLS

Por defecto, Valet sirve sitios a través de HTTP. Sin embargo, si deseas servir un sitio a través de TLS encriptado utilizando HTTP/2, puedes usar el comando secure. Por ejemplo, si tu sitio está siendo servido por Valet en el dominio laravel.test, debes ejecutar el siguiente comando para asegurarlo:

valet secure laravel

Para "desasegurar" un sitio y volver a servir su tráfico a través de HTTP en texto plano, utiliza el comando unsecure. Al igual que el comando secure, este comando acepta el nombre de host que deseas desasegurar:

valet unsecure laravel

Servir un Sitio por Defecto

A veces, puede que desees configurar Valet para que sirva un sitio "predeterminado" en lugar de un 404 al visitar un dominio test desconocido. Para lograr esto, puedes añadir una opción default a tu archivo de configuración ~/.config/valet/config.json que contenga la ruta al sitio que debería servir como tu sitio predeterminado:

"default": "/Users/Sally/Sites/example-site",

Versiones PHP por Sitio

Por defecto, Valet utiliza tu instalación global de PHP para servir tus sitios. Sin embargo, si necesitas admitir múltiples versiones de PHP en varios sitios, puedes usar el comando isolate para especificar qué versión de PHP debe usar un sitio en particular. El comando isolate configura Valet para usar la versión de PHP especificada para el sitio ubicado en tu directorio de trabajo actual:

cd ~/Sites/example-site
 
valet isolate php@8.0

Si el nombre de tu sitio no coincide con el nombre del directorio que lo contiene, puedes especificar el nombre del sitio utilizando la opción --site:

valet isolate php@8.0 --site="site-name"

Para su conveniencia, puedes usar los comandos valet php, composer y which-php para dirigir las llamadas al CLI de PHP o herramienta apropiada según la versión de PHP configurada para el sitio:

valet php
valet composer
valet which-php

Puedes ejecutar el comando isolated para mostrar una lista de todos tus sitios aislados y sus versiones de PHP:

valet isolated

Para revertir un sitio a la versión de PHP instalada globalmente por Valet, puedes invocar el comando unisolate desde el directorio raíz del sitio:

valet unisolate

Sitios de Compartición

Valet incluye un comando para compartir tus sitios locales con el mundo, proporcionando una manera fácil de probar tu sitio en dispositivos móviles o compartirlo con miembros del equipo y clientes. Out of the box, Valet admite compartir tus sitios a través de ngrok o Expose. Antes de compartir un sitio, debes actualizar tu configuración de Valet utilizando el comando share-tool, especificando ya sea ngrok o expose:

valet share-tool ngrok

Si eliges una herramienta y no la tienes instalada a través de Homebrew (para ngrok) o Composer (para Expose), Valet te solicitará automáticamente que la instales. Por supuesto, ambas herramientas requieren que autentiques tu cuenta de ngrok o Expose antes de que puedas comenzar a compartir sitios. Para compartir un sitio, navega al directorio del sitio en tu terminal y ejecuta el comando share de Valet. Se colocará una URL de acceso público en tu portapapeles, lista para pegar directamente en tu navegador o para compartir con tu equipo:

cd ~/Sites/laravel
 
valet share

Para dejar de compartir tu sitio, puedes presionar Control + C.

[!WARNING] Si estás utilizando un servidor DNS personalizado (como 1.1.1.1), es posible que el uso compartido de ngrok no funcione correctamente. Si este es el caso en tu máquina, abre la configuración del sistema de tu Mac, ve a la configuración de Red, abre la configuración Avanzada, luego ve a la pestaña DNS y agrega 127.0.0.1 como tu primer servidor DNS.

Compartiendo sitios a través de Ngrok

Compartir tu sitio utilizando ngrok requiere que crees una cuenta en ngrok y configures un token de autenticación. Una vez que tengas un token de autenticación, puedes actualizar tu configuración de Valet con ese token:

valet set-ngrok-token YOUR_TOKEN_HERE

[!NOTA] Puedes pasar parámetros adicionales de ngrok al comando share, como valet share --region=eu. Para obtener más información, consulta la documentación de ngrok.

Compartiendo Sitios a través de Expose

Compartir tu sitio utilizando Expose requiere que crees una cuenta de Expose y autenticarse con Expose a través de tu token de autenticación. Puedes consultar la documentación de Expose para obtener información sobre los parámetros adicionales de línea de comandos que admite.

Compartiendo Sitios en Tu Red Local

Valet restringe el tráfico entrante a la interfaz interna 127.0.0.1 por defecto, para que tu máquina de desarrollo no esté expuesta a riesgos de seguridad provenientes de Internet. Si deseas permitir que otros dispositivos en tu red local accedan a los sitios de Valet en tu máquina a través de la dirección IP de tu máquina (por ejemplo: 192.168.1.10/application.test), necesitarás editar manualmente el archivo de configuración de Nginx apropiado para ese sitio y eliminar la restricción en la directiva listen. Debes eliminar el prefijo 127.0.0.1: en la directiva listen para los puertos 80 y 443. Si no has ejecutado valet secure en el proyecto, puedes abrir el acceso a la red para todos los sitios no HTTPS editando el archivo /usr/local/etc/nginx/valet/valet.conf. Sin embargo, si estás sirviendo el sitio del proyecto a través de HTTPS (has ejecutado valet secure para el sitio), entonces deberías editar el archivo ~/.config/valet/Nginx/app-name.test. Una vez que hayas actualizado tu configuración de Nginx, ejecuta el comando valet restart para aplicar los cambios de configuración.

Variables de Entorno Específicas del Sitio

Algunas aplicaciones que utilizan otros frameworks pueden depender de variables de entorno del servidor pero no proporcionan una manera para que esas variables se configuren dentro de tu proyecto. Valet te permite configurar variables de entorno específicas del sitio añadiendo un archivo .valet-env.php en la raíz de tu proyecto. Este archivo debe devolver un array de pares de variables de entorno / sitio que se añadirán al array global $_SERVER para cada sitio especificado en el array:

<?php
 
return [
    // Set $_SERVER['key'] to "value" for the laravel.test site...
    'laravel' => [
        'key' => 'value',
    ],
 
    // Set $_SERVER['key'] to "value" for all sites...
    '*' => [
        'key' => 'value',
    ],
];

Servicios de Proxy

A veces es posible que desees hacer proxy de un dominio de Valet a otro servicio en tu máquina local. Por ejemplo, es posible que necesites ejecutar Valet mientras también ejecutas un sitio separado en Docker; sin embargo, Valet y Docker no pueden bindear ambos a puerto 80 al mismo tiempo. Para resolver esto, puedes usar el comando proxy para generar un proxy. Por ejemplo, puedes hacer proxy de todo el tráfico desde http://elasticsearch.test a http://127.0.0.1:9200:

# Proxy over HTTP...
valet proxy elasticsearch http://127.0.0.1:9200
 
# Proxy over TLS + HTTP/2...
valet proxy elasticsearch http://127.0.0.1:9200 --secure

Puedes eliminar un proxy utilizando el comando unproxy:

valet unproxy elasticsearch

Puedes usar el comando proxies para listar todas las configuraciones de sitios que están proxy.

valet proxies

Controladores de Valet Personalizados

Puedes escribir tu propio "driver" de Valet para servir aplicaciones PHP que se ejecutan en un framework o CMS que no es soportado nativamente por Valet. Cuando instalas Valet, se crea un directorio ~/.config/valet/Drivers que contiene un archivo SampleValetDriver.php. Este archivo contiene una implementación de ejemplo de un driver para demostrar cómo escribir un driver personalizado. Escribir un driver solo requiere que implementes tres métodos: serves, isStaticFile y frontControllerPath. Los tres métodos reciben los valores $sitePath, $siteName y $uri como sus argumentos. El $sitePath es la ruta completamente calificada al sitio que se está sirviendo en su máquina, como /Users/Lisa/Sites/my-project. El $siteName es la parte "host" / "nombre del sitio" del dominio (my-project). El $uri es el URI de la solicitud entrante (/foo/bar). Una vez que hayas completado tu driver personalizado de Valet, colócalo en el directorio ~/.config/valet/Drivers utilizando la convención de nombres FrameworkValetDriver.php. Por ejemplo, si estás escribiendo un driver de valet personalizado para WordPress, tu nombre de archivo debe ser WordPressValetDriver.php. Vamos a echar un vistazo a una implementación de muestra de cada método que debería implementar tu driver de Valet personalizado.

El Método serves

El método serves debe devolver true si tu driver debe manejar la solicitud entrante. De lo contrario, el método debe devolver false. Así que, dentro de este método, debes intentar determinar si la ruta $sitePath dada contiene un proyecto del tipo que estás intentando servir. Por ejemplo, imaginemos que estamos escribiendo un WordPressValetDriver. Nuestro método serves podría verse así:

/**
 * Determine if the driver serves the request.
 */
public function serves(string $sitePath, string $siteName, string $uri): bool
{
    return is_dir($sitePath.'/wp-admin');
}

El método isStaticFile

La isStaticFile debe determinar si la solicitud entrante es para un archivo que es "estático", como una imagen o una hoja de estilo. Si el archivo es estático, el método debe devolver la ruta completamente calificada al archivo estático en disco. Si la solicitud entrante no es para un archivo estático, el método debe devolver false:

/**
 * Determine if the incoming request is for a static file.
 *
 * @return string|false
 */
public function isStaticFile(string $sitePath, string $siteName, string $uri)
{
    if (file_exists($staticFilePath = $sitePath.'/public/'.$uri)) {
        return $staticFilePath;
    }
 
    return false;
}

[!WARNING] El método isStaticFile solo se llamará si el método serves devuelve true para la solicitud entrante y la URI de la solicitud no es /.

El Método frontControllerPath

El método frontControllerPath debe devolver la ruta completa y calificada al "front controller" de tu aplicación, que típicamente es un archivo "index.php" o equivalente:

/**
 * Get the fully resolved path to the application's front controller.
 */
public function frontControllerPath(string $sitePath, string $siteName, string $uri): string
{
    return $sitePath.'/public/index.php';
}

Controladores Locales

Si deseas definir un driver de Valet personalizado para una sola aplicación, crea un archivo LocalValetDriver.php en el directorio raíz de la aplicación. Tu driver personalizado puede extender la clase base ValetDriver o extender un driver específico de la aplicación existente como el LaravelValetDriver:

use Valet\Drivers\LaravelValetDriver;
 
class LocalValetDriver extends LaravelValetDriver
{
    /**
     * Determine if the driver serves the request.
     */
    public function serves(string $sitePath, string $siteName, string $uri): bool
    {
        return true;
    }
 
    /**
     * Get the fully resolved path to the application's front controller.
     */
    public function frontControllerPath(string $sitePath, string $siteName, string $uri): string
    {
        return $sitePath.'/public_html/index.php';
    }
}

Otros Comandos de Valet

Directorios y Archivos de Valet

Es posible que encuentres útil la siguiente información sobre directorios y archivos mientras solucionas problemas con tu entorno Valet:

~/.config/valet

Contiene toda la configuración de Valet. Es posible que desees mantener una copia de seguridad de este directorio.

~/.config/valet/dnsmasq.d/

Este directorio contiene la configuración de DNSMasq.

~/.config/valet/Drivers/

Este directorio contiene los controladores de Valet. Los controladores determinan cómo se sirve un marco / CMS en particular.

~/.config/valet/Nginx/

Este directorio contiene todas las configuraciones de sitios Nginx de Valet. Estos archivos se reconstruyen al ejecutar los comandos install y secure.

~/.config/valet/Sites/

Este directorio contiene todos los enlaces simbólicos para tus proyectos vinculados.

~/.config/valet/config.json

Este archivo es el archivo de configuración maestro de Valet.

~/.config/valet/valet.sock

Este archivo es el socket PHP-FPM utilizado por la instalación Nginx de Valet. Esto solo existirá si PHP está funcionando correctamente.

~/.config/valet/Log/fpm-php.www.log

Este archivo es el registro de usuario para errores de PHP.

~/.config/valet/Log/nginx-error.log

Este archivo es el registro de usuario de los errores de Nginx.

/usr/local/var/log/php-fpm.log

Este archivo es el registro del sistema para los errores de PHP-FPM.

/usr/local/var/log/nginx

Este directorio contiene los logs de acceso y error de Nginx.

/usr/local/etc/php/X.X/conf.d

Este directorio contiene los archivos *.ini para varias configuraciones de PHP.

/usr/local/etc/php/X.X/php-fpm.d/valet-fpm.conf

Este archivo es el archivo de configuración del pool de PHP-FPM.

~/.composer/vendor/laravel/valet/cli/stubs/secure.valet.conf

Este archivo es la configuración predeterminada de Nginx utilizada para construir certificados SSL para tus sitios.

Acceso a Disco

Desde macOS 10.14, el acceso a algunos archivos y directorios está restringido por defecto. Estas restricciones incluyen los directorios de Escritorio, Documentos y Descargas. Además, el acceso a volúmenes de red y volúmenes extraíbles está restringido. Por lo tanto, Valet recomienda que tus carpetas del sitio se ubiquen fuera de estas ubicaciones protegidas. Sin embargo, si deseas servir sitios desde una de esas ubicaciones, necesitarás dar a Nginx "Acceso Completo al Disco". De lo contrario, puedes encontrar errores del servidor u otro comportamiento impredecible de Nginx, especialmente al servir activos estáticos. Típicamente, macOS te pedirá automáticamente que concedas a Nginx acceso completo a estas ubicaciones. O puedes hacerlo manualmente a través de Preferencias del Sistema > Seguridad y Privacidad > Privacidad y seleccionando Acceso Completo al Disco. A continuación, habilita cualquier entrada de nginx en el panel de la ventana principal.