라라벨 발렛

• 시작하기
  • 발렛 또는 홈스테드
• 설치하기
  • 업그레이드하기
• 사이트 동작시키기
  • "Park" 명령어
  • "Link" 명령어
  • TLS를 사용한 안전한 사이트
• 사이트 공유하기
• 기본 사이트 제공
• 사이트 별 환경 변수
• 사용자 정의-커스텀 발렛 드라이버
  • 로컬 드라이버
• PHP 설정
• 기타 발렛 명령어들
• Valet 디렉토리와 파일

시작하기

발렛은 Mac에서 가벼움을 선호하는 사람들을 위한 라라벨 개발 환경입니다. Vagrant도, /etc/hosts 파일도 필요하지 않습니다. 심지어 로컬 터널을 사용하여 사이트를 공유할 수도 있습니다. 우린 이런걸 좋아합니다.

라라벨 발렛 설정은 여러분의 Mac 머신이 시작할 때 백그라운드에서 항상 Nginx가 실행되도록 설정합니다. 그러면 DnsMasq를 사용하여 발렛은 *.test 도메인에 대한 모든 요청을 여러분의 로컬 머신에 설치된 사이트로 지정되도록 프록시로 동작합니다.

다시말해, 대략 7MB 의 RAM을 사용하는 매우 빠른 라라벨 개발 환경입니다. 발렛은 Vagrant 나 홈스테드를 완전히 대체하지는 않지만, 여러분이 유연하고, 속도를 중시하며, 또는 RAM 이 제한되어 있는 머신에서 동작시키는 데에는 훌륭한 대안입니다.

별다른 설정 없이도, 발렛은 다음을 지원하지만, 이게 전부는 아닙니다.

• Laravel
• Lumen
• Bedrock
• CakePHP 3
• Concrete5
• Contao
• Craft
• Drupal
• ExpressionEngine
• Jigsaw
• Joomla
• Katana
• Kirby
• Magento
• OctoberCMS
• Sculpin
• Slim
• Statamic
• Static HTML
• Symfony
• WordPress
• Zend

여러분은 발렛을 고유한 사용자 정의 드라이버를 통해서 확장할 수 있습니다.

발렛 또는 홈스테드

이미 알고 있다시피, 라라벨은 또다른 라라벨 개발 환경인 홈스테드를 제공하고 있습니다. 홈스테드와 발렛은 이용자의 로컬 개발에 대한 목적과 방식이 다릅니다. 홈스테드는 자동화된 Nginx 설정과 함께 전체 우분투 가상 머신 환경을 제공합니다. 홈스테드는 리눅스 개발 환경에 대한 전체 가상화를 원하거나, 윈도우 / 리눅스 환경에서라면 아주 멋진 선택이 됩니다.

발렛은 Mac 만을 지원하고, 그리고 여러분의 로컬 머신에 직접 PHP 와 데이터베이스 서버를 설치할 필요가 있습니다. Homebrew를 사용해서 brew install php 그리고 brew install mysql와 같은 명령어를 실행하면 손쉽게 설치가 가능합니다. 발렛은 최소한의 리소스를 사용하여 매우 빠른 로컬 개발 환경을 제공합니다, 따라서 단지 PHP / MySQL 그리고 전체 가상 개발 환경이 필요하지 않은 개발자에게 적합합니다.

Valet과 Homestead는 모두 Laravel 개발 환경을 구성하기위한 훌륭한 선택입니다. 선택은 개인적인 취향과 팀의 필요에 따라 달라질 것입니다.

설치하기

발렛은 macOS와 Homebrew를 필요로 합니다. 설치하기 전에, 여러분은 Apache 또는 Nginx 가 로컬 머신의 80번 포트를 바인딩 하지 않고 있다는 것을 확인해야 합니다.

• Homebrew 설치하거나 brew update를 사용하여 최신 버전으로 업데이트 하십시오.
• brew install php Homebrew 명령어를 사용하여 PHP7.3을 설치하십시오.
• Composer 설치.
• composer global require laravel/valet 명령어를 사용하여 컴포저로 발렛을 설치하십시오. 여러분 시스템의 "PATH" 에 ~/.composer/vendor/bin 디렉토리가 들어 있는지 확인하십시오.
• valet install 명령어를 실행하십시오. 이 명령어는 발렛과 DnsMasq 를 설치하고 설정하여 발렛 데몬을 여러분의 시스템이 시작할 때 구동되도록 등록할 것입니다.

발렛이 설치되고나면, 터미널에서 ping foobar.test 와 같은 명령어를 사용하여 아무 *.test 도메인으로 핑을 시도해보십시오. 발렛이 올바르게 설치되었다면 127.0.0.1 로 부터 응답을 확인할 수 있어야만 합니다.

발렛은 여러분의 머신이 매번 부팅될 때 자동적으로 데몬이 시작될 것입니다. 처음 발렛이 설치되어 완료되고 나면 별도의 valet start 나 valet install 을 실행할 필요가 없습니다.

다른 도메인 사용하기

기본적으로 발렛은 프로젝트를 .test TLD(Top Level Domain)를 프로젝트 에 제공합니다. 다른 도메인을 사용하고자 한다면, valet tld tld-name 명령어를 사용하면 됩니다.

예를 들어, .test 대신에 .app 을 사용하고자 한다면 valet tld app 을 실행하면 발렛이 *.app 을 프로젝트에 자동적으로 제공하게 될것입니다.

데이터베이스

데이터베이스가 필요하다면, 커맨드 라인에서 brew install [email protected]를 실행하여 MySQL를 설치해 보십시오. MySQL가 설치되고 나면, brew services start [email protected] 명령어를 통해서 서비스를 시작할 수 있습니다. 그렇게 하면 127.0.0.1 서버에 root 계정으로 패스워드 없이 접속 할 수 있습니다.

PHP 버전

Valet은 valet use php@version 명령을 사용하여 PHP 버전을 전환 할 수있게합니다. Valet은 Brew를 통해 지정된 PHP 버전을 아직 설치하지 않은 경우 설치합니다.

valet use [email protected]

valet use php

{note} Valet는 여러 개의 PHP 버전이 설치되어 있어도 한 번에 하나의 PHP 버전 만 제공합니다.

설치 재설정

Valet 설치 후 제대로 실행되지 않는 경우 composer global update 명령과 valet install을 실행하면 설치가 재설정되고 다양한 문제를 해결할 수 있습니다. 드문 경우지만 valet uninstall --force와 valet install을 실행하여 Valet를 "하드 리셋"해야 할 수도 있습니다.

업그레이드 하기

터미널에서 composer global update 명령어를 사용하여 Valet 설치파일을 업데이트 할 수 있습니다. 업그레이드가 진행되면, valet install 명령어를 실행시켜 필요한 경우 설정파일에 추가적인 업그레이드가 진행되도록 하십시오.

사이트 동작시키기

발렛이 설치되고 나면, 사이트를 동작시킬 준비가된 것입니다. 발렛은 라라벨 사이트를 구동하는데 도움을 줄 수 있는 park 와 link 두가지 명령어를 제공합니다.

park 명령어

• Mac 에 mkdir ~/Sites와 같은 명령어를 실행하여 새로운 디렉토리를 생성합니다. 다음으로, cd ~/Sites 와 valet park을 실행합니다. 이 명령어는 현재 작업 디렉토리를 사이트로 접속했을 때 발렛이 찾게 되는 디렉토리로 등록합니다.
• 다음으로 이 디렉토리에서 새로운 라라벨 사이트를 생성합니다. laravel new blog.
• 브라우저에서 http://blog.test 사이트를 열어서 확인합니다.

여기까지가 전부 입니다. 이제 여러분이 "parked(지정한)" 디렉토리 안에 생성된 라라벨 프로젝트는 자동으로 http://folder-name.test 형태로 접속할 수 있습니다.

link 명령어

link 명령어는 사이트를 동작시킬 때 사용됩니다. 이 명령어는 전체 디렉토리가 아니라 하나의 디렉토리 안에서 한개의 사이트를 제공하기를 원할 때 유용합니다.

• 명령어를 사용하기 위해서, 프로젝트 중 하나의 디렉토리에 대해서 터미널에서 valet link app-name 을 실행합니다. 발렛은 현재 작업 디렉토리를 ~/.config/valet/Sites가 지정하도록 심볼릭 링크를 생성할 것입니다.
• link 명령어를 실행한 다음에, 브라우저에서 http://app-name.test 로 접속할 수 있습니다.

링크로 연결된 디렉토리들의 모든 목록을 확인하고자 한다면, valet links 명령어를 실행하십시오. valet unlink app-name는 디렉토리에 대한 심볼릭 링크를 제거하는데 사용할 수 있습니다.

{tip} valet link 를 동일한 프로젝트에 대해서 다수의 (서브) 도메인을 통해서 사이트가 동작하도록 할 수 있습니다. 프로젝트에 서브도메인이나, 다른 도메인을 추가하려면 프로젝트 폴더에서 valet link subdomain.app-name 을 실행하십시오.

TLS를 사용한 안전한 사이트

기본적으로 발렛은 사이트를 일반적인 HTTP 를 통해서 제공합니다. 하지만 사이트를 HTTP/2 를 사용하여 TLS 암호화되어 제공하려면, secure 명령어를 사용하십시오. 예를 들어 laravel.test 도메인을 발렛을 통해서 제공하고자 한다면, 다음 명령어를 통해서 안전하게 구동해야만 합니다.

valet secure laravel

사이트를 "안전하지 않게" 되돌리고 일반적인 HTTP 로 통신하게 하려면 unsecure 명령어를 사용하십시오. secure 명령어 같이, 이 명령어는 안전한 통신을 그만두고자 하는 호스트의 이름을 전달 받습니다.

valet unsecure laravel

사이트 공유

발렛에는 여러분의 로컬 사이트를 세상과 공유하는 명령어도 포함되어 있어서 모바일 기기에서 사이트를 쉽게 테스트하거나 팀원 및 고객과 사이트를 공유 할 수 있습니다. 발렛만 설치되어 있으면 추가적인 소프트웨어의 설치도 필요하지 않습니다.

Ngrok를 통해 사이트 공유

사이트를 공유하기 위해서는, 터미널 상에서 사이트의 디렉토리로 이동한 뒤에 valet share 명령어를 입력하십시오. 공개된 접근가능한 URL 이 여러분의 클립보드에 복사되고 브라우저에서 직접 붙여넣거나 팀원들과 공유 할 수 있습니다.

사이트의 공유를 중단하려면 컨트롤 + C를 눌러 프로세스를 취소하십시오.

{tip} valet share --region=eu와 같이 추가 파라메터를 share 명령에 전달할 수 있습니다. 자세한 내용은 ngrok documentation을 참조하십시오.

로컬 네트워크에서 사이트 공유

Valet는 들어오는 트래픽을 기본적으로 내부 127.0.0.1 인터페이스로 제한합니다. 이렇게하면 개발 시스템이 인터넷의 보안 위험에 노출되지 않습니다.

로컬 네트워크의 다른 장치가 컴퓨터의 IP 주소를 통해 컴퓨터의 Valet 사이트에 접속하도록하려면, (예 : 192.168.1.10/app-name.test) 해당 사이트에 대한 적절한 Nginx 설정파일을 수동으로 편집하여 포트 80 및 443에 대한 지시문에서 127.0.0.1: 접두어를 제거하여 listen 지시문에 대한 제한 사항을 제거해야합니다.

프로젝트에서 valet secure를 실행하지 않은 경우 /usr/local/etc/nginx/valet/valet.conf 파일을 편집하여 모든 비 HTTPS 사이트에 대한 네트워크 액세스를 열 수 있습니다. 그러나 HTTPS를 통해 프로젝트 사이트를 제공하는 경우 (사이트에 대해 valet secure를 실행 한 경우) ~/.config/valet/Nginx/app-name.test 파일을 편집해야합니다.

Nginx 설정을 변경하고 나면 valet restart 명령을 실행하여 설정을 변경하십시오.

사이트 별 환경변수

다른 프레임워크를 사용하는 일부 애플리케이션은 서버 환경 변수에 의존 할 수 있지만 이 변수를 프로젝트 내에 추가하는 방법을 제공하지는 않습니다. Valet을 사용하면 프로젝트의 루트 내에 .valet-env.php 파일을 추가하여 사이트 별 환경 변수를 구성 할 수 있습니다. 이 변수들은 $_SERVER 전역 변수의 배열에 추가 될 것입니다.

<?php

// Set $_SERVER['key'] to "value" for the foo.test site...
return [
    'foo' => [
        'key' => 'value',
    ],
];

// Set $_SERVER['key'] to "value" for all sites...
return [
    '*' => [
        'key' => 'value',
    ],
];

기본 사이트 제공

알 수없는 test 도메인을 방문 할 때 Valet가 404대신 "기본"사이트를 제공하도록 설정 할 수도 있습니다. 이를 위해 ~/.config/valet/config.json 설정 파일에 기본 사이트로 작동해야하는 사이트 경로를 포함하는 default 옵션을 추가 할 수 있습니다.

"default": "/Users/Sally/Sites/foo",

사용자 정의-커스텀 발렛 드라이버

여러분은 발렛에서 기본적으로 지원하고 있지 않은 다른 프레임워크나 CMS와 같은 PHP 애플리케이션을 제공하기 위해서 여러분의 고유한 발렛 "드라이버"를 작성할 수 있습니다. 발렛을 설치할 때 생성되는 ~/.config/valet/Drivers에는 SampleValetDriver.php 파일이 들어 있습니다. 이 파일은 어떻게 사용자 정의 드라이버를 작성할 것인가에 대한 샘플 드라이버의 구현 코드입니다. 드라이버를 구현하는데 필요한 메소드는 serves, isStaticFile, 그리고 frontControllerPath의 3가지 입니다.

세가지 메소드들 모두 $sitePath, $siteName, 그리고 $uri 값을 인자로 받습니다. $sitePath 는 /Users/Lisa/Sites/my-project와 같은 여러분의 머신에서 사이트가 제공되기 할 전체 경로 입니다. $siteName 는 도메인의 "호스트" / "사이트 이름" 부분 입니다(my-project). $uri 는 유입되는 요청 URI 입니다(/foo/bar).

여러분의 발렛 드라이버를 작성하고 나면, 이 파일을 FrameworkValetDriver.php 네이밍 컨벤션에 맞게 ~/.config/valet/Drivers 디렉토리에 저장하십시오. 예를 들자면, 여러분이 워드프레스를 위한 발렛 드라이버를 작성하였다면 여러분의 파일 이름음 WordPressValetDriver.php가 되어야 합니다.

사용자 정의 발렛 드라이버에서 구현하는 메소드의 샘플 코드를 살펴 보겠습니다.

serves 메소드

serves 메소드는 드라이버가 유입된 요청을 처리해야 할 경우 true를 반환합니다. 그렇지 않은 경우는 false를 반환합니다. 따라서 이 메소드 안에서 여러분은 주어진 $sitePath 가 동작시키고자 하는 유형의 프로젝트인지 확인도록 해야합니다.

예를 들어, WordPressValetDriver를 작성한다고 가정해 봅시다. serves 메소드는 다음과 같을 것입니다.

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

isStaticFile 메소드

isStaticFile 는 유입된 요청이 이미지나 스타일 시트와 같은 "정적" 파일인지 판단합니다. 파일이 정적파일이라면 해당 파일이 존재하는 디스크의 전체 경로를 반환합니다. 유입된 요청이 정적 파일이 아니라면 false 를 반환해야 합니다.

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

    return false;
}

{note} isStaticFile 메소드는 유입된 요청이 / 가 아니고 serves 메소드가 true를 반환하는 경우에만 호출될 것입니다.

frontControllerPath 메소드

frontControllerPath 메소드는 일반적으로 "index.php" 파일 또는 유사한 파일이 되는 애플리케이션의 "프론트 컨트롤러"에 대한 전체 경로를 반환합니다.

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

로컬 드라이버

하나의 애플리케이션을 위한 커스텀 Valet 드라이버를 정의하고자 한다면, 애플리케이션의 루트 디렉토리에 LocalValetDriver.php 파일을 생성하십시오. 커스텀 드라이버는 베이스 ValetDriver 클래스를 상속받거나 LaravelValetDriver과 같은 기존 애플리케이션에서 지정한 드라이버를 상속해야합니다.

class LocalValetDriver extends LaravelValetDriver
{
    /**
     * Determine if the driver serves the request.
     *
     * @param  string  $sitePath
     * @param  string  $siteName
     * @param  string  $uri
     * @return bool
     */
    public function serves($sitePath, $siteName, $uri)
    {
        return true;
    }

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

PHP 설정

/usr/local/etc/php/7.X/conf.d/디렉토리에 PHP 설정 .ini 파일을 추가하여 PHP 설치를 커스터마이징 할 수 있습니다. 이러한 설정을 추가하거나 업데이트하면 valet restart php를 실행해야합니다.

PHP 메모리 제한

Valet은 기본적으로 /usr/local/etc/php/7.X/conf.d/php-memory-limits.ini 설정 파일에서 PHP 설치의 메모리 제한과 최대 파일 업로드 크기를 지정합니다. 이는 CLI 및 FPM PHP 프로세스 모두에 영향을줍니다.

PHP-FPM 프로세스 풀

Valet의 PHP-FPM 설정은 /usr/local/etc/php/7.X/php-fpm.d/valet-fpm.conf 설정 파일에 들어 있습니다. 이 파일에서 PHP 애플리케이션이 사용하는 FPM 서버 및 자식 프로세스 수를 늘릴 수 있습니다.

기타 발렛 명령어들

Valet 디렉토리 및 파일

Valet 환경설정 관련 문제를 해결하기 위해 다음 디렉토리 및 파일 정보가 도움이 될 수 있습니다.

Laravel Valet

• Introduction
  • Valet Or Homestead
• Installation
  • Upgrading
• Serving Sites
  • The "Park" Command
  • The "Link" Command
  • Securing Sites With TLS
• Sharing Sites
• Site Specific Environment Variables
• Proxying Services
• Custom Valet Drivers
  • Local Drivers
• Other Valet Commands
• Valet Directories & Files

Introduction

Valet is a Laravel development environment for Mac minimalists. No Vagrant, no /etc/hosts file. You can even share your sites publicly using local tunnels. Yeah, we like it too.

Laravel Valet configures your Mac to always run Nginx in the background when your machine starts. Then, using DnsMasq, Valet proxies all requests on the *.test domain to point to sites installed on your local machine.

In other words, a blazing fast Laravel development environment that uses roughly 7 MB of RAM. Valet isn't a complete replacement for Vagrant or Homestead, but provides a great alternative if you want flexible basics, prefer extreme speed, or are working on a machine with a limited amount of RAM.

Out of the box, Valet support includes, but is not limited to:

However, you may extend Valet with your own custom drivers.

Valet Or Homestead

As you may know, Laravel offers Homestead, another local Laravel development environment. Homestead and Valet differ in regards to their intended audience and their approach to local development. Homestead offers an entire Ubuntu virtual machine with automated Nginx configuration. Homestead is a wonderful choice if you want a fully virtualized Linux development environment or are on Windows / Linux.

Valet only supports Mac, and requires you to install PHP and a database server directly onto your local machine. This is easily achieved by using Homebrew with commands like brew install php and brew install mysql. Valet provides a blazing fast local development environment with minimal resource consumption, so it's great for developers who only require PHP / MySQL and do not need a fully virtualized development environment.

Both Valet and Homestead are great choices for configuring your Laravel development environment. Which one you choose will depend on your personal taste and your team's needs.

Installation

Valet requires macOS and Homebrew. Before installation, you should make sure that no other programs such as Apache or Nginx are binding to your local machine's port 80.

Once Valet is installed, try pinging any *.test domain on your terminal using a command such as ping foobar.test. If Valet is installed correctly you should see this domain responding on 127.0.0.1.

Valet will automatically start its daemon each time your machine boots. There is no need to run valet start or valet install ever again once the initial Valet installation is complete.

Using Another Domain

By default, Valet serves your projects using the .test TLD. If you'd like to use another domain, you can do so using the valet tld tld-name command.

For example, if you'd like to use .app instead of .test, run valet tld app and Valet will start serving your projects at *.app automatically.

Database

If you need a database, try MySQL by running brew install [email protected] on your command line. Once MySQL has been installed, you may start it using the brew services start [email protected] command. You can then connect to the database at 127.0.0.1 using the root username and an empty string for the password.

PHP Versions

Valet allows you to switch PHP versions using the valet use php@version command. Valet will install the specified PHP version via Brew if it is not already installed:

valet use [email protected]

valet use php

{note} Valet only serves one PHP version at a time, even if you have multiple PHP versions installed.

Resetting Your Installation

If you are having trouble getting your Valet installation to run properly, executing the composer global update command followed by valet install will reset your installation and can solve a variety of problems. In rare cases it may be necessary to "hard reset" Valet by executing valet uninstall --force followed by valet install.

Upgrading

You may update your Valet installation using the composer global update command in your terminal. After upgrading, it is good practice to run the valet install command so Valet can make additional upgrades to your configuration files if necessary.

Serving Sites

Once Valet is installed, you're ready to start serving sites. Valet provides two commands to help you serve your Laravel sites: park and link.

The park Command

That's all there is to it. Now, any Laravel project you create within your "parked" directory will automatically be served using the http://folder-name.test convention.

The link Command

The link command may also be used to serve your Laravel sites. This command is useful if you want to serve a single site in a directory and not the entire directory.

To see a listing of all of your linked directories, run the valet links command. You may use valet unlink app-name to destroy the symbolic link.

{tip} You can use valet link to serve the same project from multiple (sub)domains. To add a subdomain or another domain to your project run valet link subdomain.app-name from the project folder.

Securing Sites With TLS

By default, Valet serves sites over plain HTTP. However, if you would like to serve a site over encrypted TLS using HTTP/2, use the secure command. For example, if your site is being served by Valet on the laravel.test domain, you should run the following command to secure it:

valet secure laravel

To "unsecure" a site and revert back to serving its traffic over plain HTTP, use the unsecure command. Like the secure command, this command accepts the host name that you wish to unsecure:

valet unsecure laravel

Sharing Sites

Valet even includes a command to share your local sites with the world, providing an easy way to test your site on mobile devices or share it with team members and clients. No additional software installation is required once Valet is installed.

Sharing Sites Via Ngrok

To share a site, navigate to the site's directory in your terminal and run the valet share command. A publicly accessible URL will be inserted into your clipboard and is ready to paste directly into your browser or share with your team.

To stop sharing your site, hit Control + C to cancel the process.

{tip} You may pass additional parameters to the share command, such as valet share --region=eu. For more information, consult the ngrok documentation.

Sharing Sites Via Expose

If you have Expose installed, you can share your site by navigating to the site's directory in your terminal and running the expose command. Consult the expose documentation for additional command-line parameters it supports. After sharing the site, Expose will display the sharable URL that you may use on your other devices or amongst team members.

To stop sharing your site, hit Control + C to cancel the process.

Sharing Sites On Your Local Network

Valet restricts incoming traffic to the internal 127.0.0.1 interface by default. This way your development machine isn't exposed to security risks from the Internet.

If you wish to allow other devices on your local network to access the Valet sites on your machine via your machine's IP address (eg: 192.168.1.10/app-name.test), you will need to manually edit the appropriate Nginx configuration file for that site to remove the restriction on the listen directive by removing the the 127.0.0.1: prefix on the directive for ports 80 and 443.

If you have not run valet secure on the project, you can open up network access for all non-HTTPS sites by editing the /usr/local/etc/nginx/valet/valet.conf file. However, if you're serving the project site over HTTPS (you have run valet secure for the site) then you should edit the ~/.config/valet/Nginx/app-name.test file.

Once you have updated your Nginx configuration, run the valet restart command to apply the configuration changes.

Site Specific Environment Variables

Some applications using other frameworks may depend on server environment variables but do not provide a way for those variables to be configured within your project. Valet allows you to configure site specific environment variables by adding a .valet-env.php file within the root of your project. These variables will be added to the $_SERVER global array:

<?php

// Set $_SERVER['key'] to "value" for the foo.test site...
return [
    'foo' => [
        'key' => 'value',
    ],
];

// Set $_SERVER['key'] to "value" for all sites...
return [
    '*' => [
        'key' => 'value',
    ],
];

Proxying Services

Sometimes you may wish to proxy a Valet domain to another service on your local machine. For example, you may occasionally need to run Valet while also running a separate site in Docker; however, Valet and Docker can't both bind to port 80 at the same time.

To solve this, you may use the proxy command to generate a proxy. For example, you may proxy all traffic from http://elasticsearch.test to http://127.0.0.1:9200:

valet proxy elasticsearch http://127.0.0.1:9200

You may remove a proxy using the unproxy command:

valet unproxy elasticsearch

You may use the proxies command to list all site configuration that are proxied:

valet proxies

Custom Valet Drivers

You can write your own Valet "driver" to serve PHP applications running on another framework or CMS that is not natively supported by Valet. When you install Valet, a ~/.config/valet/Drivers directory is created which contains a SampleValetDriver.php file. This file contains a sample driver implementation to demonstrate how to write a custom driver. Writing a driver only requires you to implement three methods: serves, isStaticFile, and frontControllerPath.

All three methods receive the $sitePath, $siteName, and $uri values as their arguments. The $sitePath is the fully qualified path to the site being served on your machine, such as /Users/Lisa/Sites/my-project. The $siteName is the "host" / "site name" portion of the domain (my-project). The $uri is the incoming request URI (/foo/bar).

Once you have completed your custom Valet driver, place it in the ~/.config/valet/Drivers directory using the FrameworkValetDriver.php naming convention. For example, if you are writing a custom valet driver for WordPress, your file name should be WordPressValetDriver.php.

Let's take a look at a sample implementation of each method your custom Valet driver should implement.

The serves Method

The serves method should return true if your driver should handle the incoming request. Otherwise, the method should return false. So, within this method you should attempt to determine if the given $sitePath contains a project of the type you are trying to serve.

For example, let's pretend we are writing a WordPressValetDriver. Our serves method might look something like this:

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

The isStaticFile Method

The isStaticFile should determine if the incoming request is for a file that is "static", such as an image or a stylesheet. If the file is static, the method should return the fully qualified path to the static file on disk. If the incoming request is not for a static file, the method should return false:

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

    return false;
}

{note} The isStaticFile method will only be called if the serves method returns true for the incoming request and the request URI is not /.

The frontControllerPath Method

The frontControllerPath method should return the fully qualified path to your application's "front controller", which is typically your "index.php" file or equivalent:

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

Local Drivers

If you would like to define a custom Valet driver for a single application, create a LocalValetDriver.php in the application's root directory. Your custom driver may extend the base ValetDriver class or extend an existing application specific driver such as the LaravelValetDriver:

class LocalValetDriver extends LaravelValetDriver
{
    /**
     * Determine if the driver serves the request.
     *
     * @param  string  $sitePath
     * @param  string  $siteName
     * @param  string  $uri
     * @return bool
     */
    public function serves($sitePath, $siteName, $uri)
    {
        return true;
    }

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

Other Valet Commands

Valet Directories & Files

You may find the following directory and file information helpful while troubleshooting issues with your Valet environment: