Laravel Sail - Laravel 11.x - The PHP Framework For Web Artisans

<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <title>Laravel Sail - Laravel 11.x - The PHP Framework For Web Artisans</title> <meta name="viewport" content="width=device-width, initial-scale=1, viewport-fit=cover"> <link rel="canonical" href="https://laravel.com/docs/11.x/sail">  <meta name="title" content="Laravel - The PHP Framework For Web Artisans"> <meta name="description" content="Laravel is a PHP web application framework with expressive, elegant syntax. We’ve already laid the foundation — freeing you to create without sweating the small things.">  <meta property="og:type" content="website"> <meta property="og:url" content="https://laravel.com/"> <meta property="og:title" content="Laravel - The PHP Framework For Web Artisans"> <meta property="og:description" content="Laravel is a PHP web application framework with expressive, elegant syntax. We’ve already laid the foundation — freeing you to create without sweating the small things."> <meta property="og:image" content="https://laravel.com/img/og-image.jpg">  <meta property="twitter:card" content="summary_large_image"> <meta property="twitter:url" content="https://laravel.com/"> <meta property="twitter:title" content="Laravel - The PHP Framework For Web Artisans"> <meta property="twitter:description" content="Laravel is a PHP web application framework with expressive, elegant syntax. We’ve already laid the foundation — freeing you to create without sweating the small things."> <meta property="twitter:image" content="https://laravel.com/img/og-image.jpg">  <link rel="apple-touch-icon" sizes="180x180" href="/img/favicon/apple-touch-icon.png"> <link rel="icon" type="image/png" sizes="32x32" href="/img/favicon/favicon-32x32.png"> <link rel="icon" type="image/png" sizes="16x16" href="/img/favicon/favicon-16x16.png"> <link rel="manifest" href="/img/favicon/site.webmanifest"> <link rel="mask-icon" href="/img/favicon/safari-pinned-tab.svg" color="#ff2d20"> <link rel="shortcut icon" href="/img/favicon/favicon.ico"> <meta name="msapplication-TileColor" content="#ff2d20"> <meta name="msapplication-config" content="/img/favicon/browserconfig.xml"> <meta name="theme-color" content="#ffffff"> <meta name="color-scheme" content="light"> <link rel="preconnect" href="https://E3MIRNPJH5-dsn.algolia.net" crossorigin /> <link rel="stylesheet" href="https://use.typekit.net/ins2wgm.css"> <link rel="preload" as="style" href="https://laravel.com/build/assets/app-BtzO9dTe.css" /><link rel="modulepreload" href="https://laravel.com/build/assets/app-BOWVlUZW.js" /><link rel="modulepreload" href="https://laravel.com/build/assets/docs-CrJG7rMg.js" /><link rel="stylesheet" href="https://laravel.com/build/assets/app-BtzO9dTe.css" /><script type="module" src="https://laravel.com/build/assets/app-BOWVlUZW.js"></script><script type="module" src="https://laravel.com/build/assets/docs-CrJG7rMg.js"></script>  <script src="https://cdn.usefathom.com/script.js" data-site="DVMEKBYF" defer></script>   <script async src="https://tag.clearbitscripts.com/v1/pk_97d2bf69f817feb07be42fcda1460119/tags.js" referrerpolicy="strict-origin-when-cross-origin"></script> <script> const alwaysLightMode = false; </script> <script> function updateTheme() { if (!('theme' in localStorage)) { localStorage.theme = 'system'; } switch (localStorage.theme) { case 'system': if (window.matchMedia('(prefers-color-scheme: dark)').matches) { document.documentElement.classList.add('dark'); document.documentElement.setAttribute('data-theme', 'dark'); } else { document.documentElement.classList.remove('dark'); document.documentElement.setAttribute('data-theme', 'light'); } document.documentElement.setAttribute('color-theme', 'system'); break; case 'dark': document.documentElement.classList.add('dark'); document.documentElement.setAttribute('color-theme', 'dark'); document.documentElement.setAttribute('data-theme', 'dark'); break; case 'light': document.documentElement.classList.remove('dark'); document.documentElement.setAttribute('color-theme', 'light'); document.documentElement.setAttribute('data-theme', 'light'); break; } updateThemeAndSchemeColor(); } function updateThemeAndSchemeColor() { if (! alwaysLightMode) { if (document.documentElement.classList.contains('dark')) { document.querySelector('meta[name="color-scheme"]').setAttribute('content', 'dark'); document.querySelector('meta[name="theme-color"]').setAttribute('content', '#171923'); return; } document.querySelector('meta[name="color-scheme"]').setAttribute('content', 'light'); document.querySelector('meta[name="theme-color"]').setAttribute('content', '#ffffff'); } } updateTheme(); </script> </head> <body x-data="{ navIsOpen: false, }" class="w-full h-full font-sans antialiased text-gray-900 language-php" data-instant-intensity="0" > <a id="skip-to-content-link" href="#main-content" class="absolute bg-gray-100 px-4 py-2 top-3 left-3 text-gray-700 shadow-xl" > Skip to content </a> <div class="items-center justify-center bg-gradient-to-b from-red-500 to-red-600 p-2 text-center text-white text-sm h-9"> <template id="news-herd"> <div> <svg xmlns="http://www.w3.org/2000/svg" class="w-5 h-5 text-white" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" stroke-linecap="round" fill="none" stroke-linejoin="round"> <path stroke="none" d="M0 0h24v24H0z" fill="none"/> <path d="M3 4m0 1a1 1 0 0 1 1 -1h16a1 1 0 0 1 1 1v14a1 1 0 0 1 -1 1h-16a1 1 0 0 1 -1 -1z" /> <path d="M7 8v1" /> <path d="M17 8v1" /> <path d="M12.5 4c-.654 1.486 -1.26 3.443 -1.5 9h2.5c-.19 2.867 .094 5.024 .5 7" /> <path d="M7 15.5c3.667 2 6.333 2 10 0" /> </svg> </div> <div class="mt-px ml-1"> Get started with PHP and Laravel faster than ever using <a href="https://herd.laravel.com" class="underline">Laravel Herd</a>. </div> </template> <template id="news-laracon"> <div><svg class="w-5 h-5 text-white" fill="none" stroke="currentColor" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><path stroke-linecap="round" stroke-linejoin="round" stroke-width="2" d="M3.055 11H5a2 2 0 012 2v1a2 2 0 002 2 2 2 0 012 2v2.945M8 3.935V5.5A2.5 2.5 0 0010.5 8h.5a2 2 0 012 2 2 2 0 104 0 2 2 0 012-2h1.064M15 20.488V18a2 2 0 012-2h3.064M21 12a9 9 0 11-18 0 9 9 0 0118 0z"></path></svg></div> <div class="mt-px ml-1"> Join us in Dallas, TX! Tickets are now available for <a href="https://laracon.us" class="underline">Laracon US</a>. </div> </template> <template id="news-laracon-in"> <div><svg class="w-5 h-5 text-white" fill="none" stroke="currentColor" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><path stroke-linecap="round" stroke-linejoin="round" stroke-width="2" d="M3.055 11H5a2 2 0 012 2v1a2 2 0 002 2 2 2 0 012 2v2.945M8 3.935V5.5A2.5 2.5 0 0010.5 8h.5a2 2 0 012 2 2 2 0 104 0 2 2 0 012-2h1.064M15 20.488V18a2 2 0 012-2h3.064M21 12a9 9 0 11-18 0 9 9 0 0118 0z"></path></svg></div> <div class="mt-px ml-1"> Let's go to India! Tickets are now available for <a href="https://laracon.in" class="underline">Laracon IN</a>. </div> </template> <template id="news-laracon-eu"> <div><svg class="w-5 h-5 text-white" fill="none" stroke="currentColor" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><path stroke-linecap="round" stroke-linejoin="round" stroke-width="2" d="M3.055 11H5a2 2 0 012 2v1a2 2 0 002 2 2 2 0 012 2v2.945M8 3.935V5.5A2.5 2.5 0 0010.5 8h.5a2 2 0 012 2 2 2 0 104 0 2 2 0 012-2h1.064M15 20.488V18a2 2 0 012-2h3.064M21 12a9 9 0 11-18 0 9 9 0 0118 0z"></path></svg></div> <div class="mt-px ml-1"> Let's go to Europe! Tickets are now available for <a href="https://laracon.eu" class="underline">Laracon EU</a>. </div> </template> <template id="news-laracon-au"> <div><svg class="w-5 h-5 text-white" fill="none" stroke="currentColor" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><path stroke-linecap="round" stroke-linejoin="round" stroke-width="2" d="M3.055 11H5a2 2 0 012 2v1a2 2 0 002 2 2 2 0 012 2v2.945M8 3.935V5.5A2.5 2.5 0 0010.5 8h.5a2 2 0 012 2 2 2 0 104 0 2 2 0 012-2h1.064M15 20.488V18a2 2 0 012-2h3.064M21 12a9 9 0 11-18 0 9 9 0 0118 0z"></path></svg></div> <div class="mt-px ml-1"> Let's go down under! Tickets are now available for <a href="https://laracon.au" class="underline">Laracon AU</a>. </div> </template> <template id="news-forge"> <div><svg class="w-5 h-5 text-white" fill="none" stroke="currentColor" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><path stroke-linecap="round" stroke-linejoin="round" stroke-width="2" d="M9.75 17L9 20l-1 1h8l-1-1-.75-3M3 13h18M5 17h14a2 2 0 002-2V5a2 2 0 00-2-2H5a2 2 0 00-2 2v10a2 2 0 002 2z"></path></svg></div> <div class="mt-px ml-1"> Servers with PHP 8.3 are now available for provisioning via <a href="https://forge.laravel.com" class="underline">Laravel Forge</a>. </div> </template> <template id="news-vapor"> <div><svg class="w-5 h-5 text-white" fill="none" stroke="currentColor" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><path stroke-linecap="round" stroke-linejoin="round" stroke-width="2" d="M3 15a4 4 0 004 4h9a5 5 0 10-.1-9.999 5.002 5.002 0 10-9.78 2.096A4.001 4.001 0 003 15z"></path></svg></div> <div class="mt-px ml-1"> Deploy Laravel with the infinite scale of serverless using <a href="https://vapor.laravel.com" class="underline">Laravel Vapor</a>. </div> </template> <template id="news-cloud"> <div class="mt-px ml-1"> Join the waitlist for <a href="https://cloud.laravel.com" class="underline">Laravel Cloud</a><span class="hidden md:inline">, the future of shipping</span>. </div> </template> <template id="news-nightwatch"> <div class="mt-px ml-1"> Join the waitlist for <a href="https://nightwatch.laravel.com" class="underline">Laravel Nightwatch</a><span class="hidden md:inline">, first-class monitoring designed for Laravel</span>. </div> </template> <template id="news-pulse"> <div><svg class="w-5 h-5 text-white" fill="none" stroke="currentColor" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><path stroke-linecap="round" stroke-linejoin="round" stroke-width="2" d="M3 15a4 4 0 004 4h9a5 5 0 10-.1-9.999 5.002 5.002 0 10-9.78 2.096A4.001 4.001 0 003 15z"></path></svg></div> <div class="mt-px ml-1"> How's your health? Check your application's vital signs using <a href="https://pulse.laravel.com" class="underline">Laravel Pulse</a>. </div> </template> <template id="news-reverb"> <div> <svg xmlns="http://www.w3.org/2000/svg" class="w-5 h-5 text-white" width="44" height="44" viewBox="0 0 24 24" stroke-width="1.5" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"> <path stroke="none" d="M0 0h24v24H0z" fill="none"/> <path d="M3.707 6.293l2.586 -2.586a1 1 0 0 1 1.414 0l5.586 5.586a1 1 0 0 1 0 1.414l-2.586 2.586a1 1 0 0 1 -1.414 0l-5.586 -5.586a1 1 0 0 1 0 -1.414z" /> <path d="M6 10l-3 3l3 3l3 -3" /> <path d="M10 6l3 -3l3 3l-3 3" /> <path d="M12 12l1.5 1.5" /> <path d="M14.5 17a2.5 2.5 0 0 0 2.5 -2.5" /> <path d="M15 21a6 6 0 0 0 6 -6" /> </svg> </div> <div class="mt-px ml-1"> Incoming transmission received. <a href="https://reverb.laravel.com" class="underline">Laravel Reverb</a> is now available! </div> </template> <template id="news-nova"> <div> <svg class="w-5 h-5 text-white" fill="none" stroke="currentColor" stroke-width="1.5" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg" aria-hidden="true"> <path stroke-linecap="round" stroke-linejoin="round" d="M15.59 14.37a6 6 0 01-5.84 7.38v-4.8m5.84-2.58a14.98 14.98 0 006.16-12.12A14.98 14.98 0 009.631 8.41m5.96 5.96a14.926 14.926 0 01-5.841 2.58m-.119-8.54a6 6 0 00-7.381 5.84h4.8m2.581-5.84a14.927 14.927 0 00-2.58 5.84m2.699 2.7c-.103.021-.207.041-.311.06a15.09 15.09 0 01-2.448-2.448 14.9 14.9 0 01.06-.312m-2.24 2.39a4.493 4.493 0 00-1.757 4.306 4.493 4.493 0 004.306-1.758M16.5 9a1.5 1.5 0 11-3 0 1.5 1.5 0 013 0z"></path> </svg> </div> <div class="mt-px ml-1"> Take your administration backend to another dimension with <a href="https://nova.laravel.com" class="underline">Laravel Nova</a>. </div> </template> <template id="news-careers"> <div> <svg class="w-5 h-5 text-white" xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke-width="1.5" stroke="currentColor" class="w-6 h-6"> <path stroke-linecap="round" stroke-linejoin="round" d="M20.25 14.15v4.25c0 1.094-.787 2.036-1.872 2.18-2.087.277-4.216.42-6.378.42s-4.291-.143-6.378-.42c-1.085-.144-1.872-1.086-1.872-2.18v-4.25m16.5 0a2.18 2.18 0 0 0 .75-1.661V8.706c0-1.081-.768-2.015-1.837-2.175a48.114 48.114 0 0 0-3.413-.387m4.5 8.006c-.194.165-.42.295-.673.38A23.978 23.978 0 0 1 12 15.75c-2.648 0-5.195-.429-7.577-1.22a2.016 2.016 0 0 1-.673-.38m0 0A2.18 2.18 0 0 1 3 12.489V8.706c0-1.081.768-2.015 1.837-2.175a48.111 48.111 0 0 1 3.413-.387m7.5 0V5.25A2.25 2.25 0 0 0 13.5 3h-3a2.25 2.25 0 0 0-2.25 2.25v.894m7.5 0a48.667 48.667 0 0 0-7.5 0M12 12.75h.008v.008H12v-.008Z" /> </svg> </div> <div class="mt-px ml-1"> Laravel is hiring! <a href="https://laravel.com/careers" class="underline">Help us build the future of Laravel</a>. </div> </template> </div> <script> const activeNewsTemplate = document.getElementById( 'news-'+JSON.parse('[\u0022cloud\u0022,\u0022nightwatch\u0022]')[Math.floor(Math.random() * 2)] ) activeNewsTemplate.replaceWith(activeNewsTemplate.content) </script> <div class="relative dark:bg-dark-700" id="docsScreen"> <div class="relative lg:flex lg:items-start"> <aside class="hidden fixed top-0 bottom-0 left-0 z-20 w-16 bg-gradient-to-b from-gray-100 to-white transition-all duration-300 lg:sticky lg:w-80 lg:shrink-0 lg:flex lg:flex-col lg:justify-end lg:items-end 2xl:max-w-lg 2xl:w-full dark:from-dark-800 dark:to-dark-700"> <div class="relative max-h-screen overflow-auto flex-1 flex flex-col xl:w-80"> <a href="/" class="flex items-center py-8 px-4 lg:px-8 xl:px-16"> <img class="w-8 h-8 shrink-0 transition-all duration-300 lg:w-12 lg:h-12" src="/img/logomark.min.svg" alt="Laravel" width="50" height="52" > <img src="/img/logotype.min.svg" alt="Laravel" class="hidden ml-4 lg:block" width="114" height="29" > </a> <div class="px-4 pb-10 lg:px-8 xl:px-16"> <nav id="indexed-nav" class="hidden lg:block lg:mt-4"> <div class="docs_sidebar"> <ul> <li> <h2>Prologue</h2> <ul> <li> <a href="/docs/11.x/releases">Release Notes</a> </li> <li> <a href="/docs/11.x/upgrade">Upgrade Guide</a> </li> <li> <a href="/docs/11.x/contributions">Contribution Guide</a> </li> </ul> </li> <li> <h2>Getting Started</h2> <ul> <li> <a href="/docs/11.x/installation">Installation</a> </li> <li> <a href="/docs/11.x/configuration">Configuration</a> </li> <li> <a href="/docs/11.x/structure">Directory Structure</a> </li> <li> <a href="/docs/11.x/frontend">Frontend</a> </li> <li> <a href="/docs/11.x/starter-kits">Starter Kits</a> </li> <li> <a href="/docs/11.x/deployment">Deployment</a> </li> </ul> </li> <li> <h2>Architecture Concepts</h2> <ul> <li> <a href="/docs/11.x/lifecycle">Request Lifecycle</a> </li> <li> <a href="/docs/11.x/container">Service Container</a> </li> <li> <a href="/docs/11.x/providers">Service Providers</a> </li> <li> <a href="/docs/11.x/facades">Facades</a> </li> </ul> </li> <li> <h2>The Basics</h2> <ul> <li> <a href="/docs/11.x/routing">Routing</a> </li> <li> <a href="/docs/11.x/middleware">Middleware</a> </li> <li> <a href="/docs/11.x/csrf">CSRF Protection</a> </li> <li> <a href="/docs/11.x/controllers">Controllers</a> </li> <li> <a href="/docs/11.x/requests">Requests</a> </li> <li> <a href="/docs/11.x/responses">Responses</a> </li> <li> <a href="/docs/11.x/views">Views</a> </li> <li> <a href="/docs/11.x/blade">Blade Templates</a> </li> <li> <a href="/docs/11.x/vite">Asset Bundling</a> </li> <li> <a href="/docs/11.x/urls">URL Generation</a> </li> <li> <a href="/docs/11.x/session">Session</a> </li> <li> <a href="/docs/11.x/validation">Validation</a> </li> <li> <a href="/docs/11.x/errors">Error Handling</a> </li> <li> <a href="/docs/11.x/logging">Logging</a> </li> </ul> </li> <li> <h2>Digging Deeper</h2> <ul> <li> <a href="/docs/11.x/artisan">Artisan Console</a> </li> <li> <a href="/docs/11.x/broadcasting">Broadcasting</a> </li> <li> <a href="/docs/11.x/cache">Cache</a> </li> <li> <a href="/docs/11.x/collections">Collections</a> </li> <li> <a href="/docs/11.x/concurrency">Concurrency</a> </li> <li> <a href="/docs/11.x/context">Context</a> </li> <li> <a href="/docs/11.x/contracts">Contracts</a> </li> <li> <a href="/docs/11.x/events">Events</a> </li> <li> <a href="/docs/11.x/filesystem">File Storage</a> </li> <li> <a href="/docs/11.x/helpers">Helpers</a> </li> <li> <a href="/docs/11.x/http-client">HTTP Client</a> </li> <li> <a href="/docs/11.x/localization">Localization</a> </li> <li> <a href="/docs/11.x/mail">Mail</a> </li> <li> <a href="/docs/11.x/notifications">Notifications</a> </li> <li> <a href="/docs/11.x/packages">Package Development</a> </li> <li> <a href="/docs/11.x/processes">Processes</a> </li> <li> <a href="/docs/11.x/queues">Queues</a> </li> <li> <a href="/docs/11.x/rate-limiting">Rate Limiting</a> </li> <li> <a href="/docs/11.x/strings">Strings</a> </li> <li> <a href="/docs/11.x/scheduling">Task Scheduling</a> </li> </ul> </li> <li> <h2>Security</h2> <ul> <li> <a href="/docs/11.x/authentication">Authentication</a> </li> <li> <a href="/docs/11.x/authorization">Authorization</a> </li> <li> <a href="/docs/11.x/verification">Email Verification</a> </li> <li> <a href="/docs/11.x/encryption">Encryption</a> </li> <li> <a href="/docs/11.x/hashing">Hashing</a> </li> <li> <a href="/docs/11.x/passwords">Password Reset</a> </li> </ul> </li> <li> <h2>Database</h2> <ul> <li> <a href="/docs/11.x/database">Getting Started</a> </li> <li> <a href="/docs/11.x/queries">Query Builder</a> </li> <li> <a href="/docs/11.x/pagination">Pagination</a> </li> <li> <a href="/docs/11.x/migrations">Migrations</a> </li> <li> <a href="/docs/11.x/seeding">Seeding</a> </li> <li> <a href="/docs/11.x/redis">Redis</a> </li> <li> <a href="/docs/11.x/mongodb">MongoDB</a> </li> </ul> </li> <li> <h2>Eloquent ORM</h2> <ul> <li> <a href="/docs/11.x/eloquent">Getting Started</a> </li> <li> <a href="/docs/11.x/eloquent-relationships">Relationships</a> </li> <li> <a href="/docs/11.x/eloquent-collections">Collections</a> </li> <li> <a href="/docs/11.x/eloquent-mutators">Mutators / Casts</a> </li> <li> <a href="/docs/11.x/eloquent-resources">API Resources</a> </li> <li> <a href="/docs/11.x/eloquent-serialization">Serialization</a> </li> <li> <a href="/docs/11.x/eloquent-factories">Factories</a> </li> </ul> </li> <li> <h2>Testing</h2> <ul> <li> <a href="/docs/11.x/testing">Getting Started</a> </li> <li> <a href="/docs/11.x/http-tests">HTTP Tests</a> </li> <li> <a href="/docs/11.x/console-tests">Console Tests</a> </li> <li> <a href="/docs/11.x/dusk">Browser Tests</a> </li> <li> <a href="/docs/11.x/database-testing">Database</a> </li> <li> <a href="/docs/11.x/mocking">Mocking</a> </li> </ul> </li> <li class="sub--on"> <h2>Packages</h2> <ul> <li> <a href="/docs/11.x/starter-kits#laravel-breeze">Breeze</a> </li> <li> <a href="/docs/11.x/billing">Cashier (Stripe)</a> </li> <li> <a href="/docs/11.x/cashier-paddle">Cashier (Paddle)</a> </li> <li> <a href="/docs/11.x/dusk">Dusk</a> </li> <li> <a href="/docs/11.x/envoy">Envoy</a> </li> <li> <a href="/docs/11.x/fortify">Fortify</a> </li> <li> <a href="/docs/11.x/folio">Folio</a> </li> <li> <a href="/docs/11.x/homestead">Homestead</a> </li> <li> <a href="/docs/11.x/horizon">Horizon</a> </li> <li> <a href="https://jetstream.laravel.com">Jetstream</a> </li> <li> <a href="/docs/11.x/mix">Mix</a> </li> <li> <a href="/docs/11.x/octane">Octane</a> </li> <li> <a href="/docs/11.x/passport">Passport</a> </li> <li> <a href="/docs/11.x/pennant">Pennant</a> </li> <li> <a href="/docs/11.x/pint">Pint</a> </li> <li> <a href="/docs/11.x/precognition">Precognition</a> </li> <li> <a href="/docs/11.x/prompts">Prompts</a> </li> <li> <a href="/docs/11.x/pulse">Pulse</a> </li> <li> <a href="/docs/11.x/reverb">Reverb</a> </li> <li class="active"> <a href="/docs/11.x/sail">Sail</a> </li> <li> <a href="/docs/11.x/sanctum">Sanctum</a> </li> <li> <a href="/docs/11.x/scout">Scout</a> </li> <li> <a href="/docs/11.x/socialite">Socialite</a> </li> <li> <a href="/docs/11.x/telescope">Telescope</a> </li> <li> <a href="/docs/11.x/valet">Valet</a> </li> </ul> </li> <li> <a href="/api/11.x">API Documentation</a> </li> </ul> </div> </nav> <template id="promote-forge"> <div class="mt-4 px-3 py-2 border-dashed border-gray-200 border rounded-lg text-xs leading-loose text-gray-700 lg:block dark:border-gray-400 dark:text-gray-200"> <span class="font-medium">Laravel Forge:</span> create and manage PHP 8 servers. Deploy your Laravel applications in seconds. <a class="underline text-red-600" href="https://forge.laravel.com">Sign up now!</a>. </div> </template> <template id="promote-vapor"> <div class="mt-4 px-3 py-2 border-dashed border-gray-200 border rounded-lg text-xs leading-loose text-gray-700 lg:block dark:border-gray-400 dark:text-gray-200"> <span class="font-medium">Laravel Vapor:</span> experience extreme scale on a dedicated serverless platform for Laravel. <a class="underline text-red-600" href="https://vapor.laravel.com">Sign up now!</a>. </div> </template> <template id="promote-nova"> <div class="mt-4 px-3 py-2 border-dashed border-gray-200 border rounded-lg text-xs leading-loose text-gray-700 lg:block dark:border-gray-400 dark:text-gray-200"> <span class="font-medium">Laravel Nova:</span> The next generation of Nova is <a class="underline text-red-600" href="https://nova.laravel.com">now available</a>. </div> </template> <template id="promote-pulse"> <div class="mt-4 px-3 py-2 border-dashed border-gray-200 border rounded-lg text-xs leading-loose text-gray-700 lg:block dark:border-gray-400 dark:text-gray-200"> <span class="font-medium">Laravel Pulse:</span> How's your health? Check your application's vital signs using <a href="https://pulse.laravel.com" class="underline text-red-600">Laravel Pulse</a>. </div> </template> <template id="promote-reverb"> <div class="mt-4 px-3 py-2 border-dashed border-gray-200 border rounded-lg text-xs leading-loose text-gray-700 lg:block dark:border-gray-400 dark:text-gray-200"> <span class="font-medium">Laravel Reverb:</span> You can easily build dynamic, real-time Laravel applications using WebSockets. <a href="https://reverb.laravel.com" class="underline text-red-600">Laravel Reverb</a> is now available! </div> </template> <script> const activePromotionTemplate = document.getElementById( 'promote-'+JSON.parse('[\u0022forge\u0022,\u0022vapor\u0022,\u0022nova\u0022,\u0022pulse\u0022,\u0022reverb\u0022]')[Math.floor(Math.random() * 5)] ) activePromotionTemplate.replaceWith(activePromotionTemplate.content) </script> </div> </div> </aside> <header class="lg:hidden" @keydown.window.escape="navIsOpen = false" @click.away="navIsOpen = false" > <div class="relative mx-auto w-full py-10 bg-white transition duration-200 dark:bg-dark-700"> <div class="mx-auto px-8 sm:px-16 flex items-center justify-between"> <a href="/" class="flex items-center"> <img class="" src="/img/logomark.min.svg" alt="Laravel" width="50" height="52"> <img class="hidden ml-5 sm:block" src="/img/logotype.min.svg" alt="Laravel" width="114" height="29"> </a> <div class="flex-1 flex items-center justify-end"> <button id="header__sun" onclick="toSystemMode()" title="Switch to system theme" class="relative w-10 h-10 focus:outline-none focus:shadow-outline text-gray-500"> <svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-sun" width="24" height="24" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"> <path stroke="none" d="M0 0h24v24H0z" fill="none"></path> <circle cx="12" cy="12" r="4"></circle> <path d="M3 12h1m8 -9v1m8 8h1m-9 8v1m-6.4 -15.4l.7 .7m12.1 -.7l-.7 .7m0 11.4l.7 .7m-12.1 -.7l-.7 .7"></path> </svg> </button> <button id="header__moon" onclick="toLightMode()" title="Switch to light mode" class="relative w-10 h-10 focus:outline-none focus:shadow-outline text-gray-500"> <svg style="width:24px;height:24px" viewBox="0 0 24 24"> <path fill="currentColor" d="M17.75,4.09L15.22,6.03L16.13,9.09L13.5,7.28L10.87,9.09L11.78,6.03L9.25,4.09L12.44,4L13.5,1L14.56,4L17.75,4.09M21.25,11L19.61,12.25L20.2,14.23L18.5,13.06L16.8,14.23L17.39,12.25L15.75,11L17.81,10.95L18.5,9L19.19,10.95L21.25,11M18.97,15.95C19.8,15.87 20.69,17.05 20.16,17.8C19.84,18.25 19.5,18.67 19.08,19.07C15.17,23 8.84,23 4.94,19.07C1.03,15.17 1.03,8.83 4.94,4.93C5.34,4.53 5.76,4.17 6.21,3.85C6.96,3.32 8.14,4.21 8.06,5.04C7.79,7.9 8.75,10.87 10.95,13.06C13.14,15.26 16.1,16.22 18.97,15.95M17.33,17.97C14.5,17.81 11.7,16.64 9.53,14.5C7.36,12.31 6.2,9.5 6.04,6.68C3.23,9.82 3.34,14.64 6.35,17.66C9.37,20.67 14.19,20.78 17.33,17.97Z" /> </svg> </button> <button id="header__indeterminate" onclick="toDarkMode()" title="Switch to dark mode" class="relative w-10 h-10 focus:outline-none focus:shadow-outline text-gray-500"> <svg style="width:24px;height:24px" viewBox="0 0 24 24"> <path fill="currentColor" d="M12 2A10 10 0 0 0 2 12A10 10 0 0 0 12 22A10 10 0 0 0 22 12A10 10 0 0 0 12 2M12 4A8 8 0 0 1 20 12A8 8 0 0 1 12 20V4Z" /> </svg> </button> <button class="ml-2 relative w-10 h-10 p-2 text-red-600 lg:hidden focus:outline-none focus:shadow-outline" aria-label="Menu" @click.prevent="navIsOpen = !navIsOpen"> <svg x-show="! navIsOpen" x-transition.opacity class="absolute inset-0 mt-2 ml-2 w-6 h-6" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2" fill="none" stroke-linecap="round" stroke-linejoin="round"><line x1="3" y1="12" x2="21" y2="12"></line><line x1="3" y1="6" x2="21" y2="6"></line><line x1="3" y1="18" x2="21" y2="18"></line></svg> <svg x-show="navIsOpen" x-transition.opacity x-cloak class="absolute inset-0 mt-2 ml-2 w-6 h-6" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2" fill="none" stroke-linecap="round" stroke-linejoin="round"><line x1="18" y1="6" x2="6" y2="18"></line><line x1="6" y1="6" x2="18" y2="18"></line></svg> </button> </div> </div> <span :class="{ 'shadow-sm': navIsOpen }" class="absolute inset-0 z-20 pointer-events-none"></span> </div> <div x-show="navIsOpen" x-transition:enter="duration-150" x-transition:leave="duration-100 ease-in" x-cloak > <nav x-show="navIsOpen" x-cloak class="absolute w-full transform origin-top shadow-sm z-10" x-transition:enter="duration-150 ease-out" x-transition:enter-start="opacity-0 -translate-y-8 scale-75" x-transition:enter-end="opacity-100 scale-100" x-transition:leave="duration-100 ease-in" x-transition:leave-start="opacity-100 scale-100" x-transition:leave-end="opacity-0 -translate-y-8 scale-75" > <div class="relative p-8 bg-white docs_sidebar dark:bg-dark-600"> <ul> <li> <h2>Prologue</h2> <ul> <li> <a href="/docs/11.x/releases">Release Notes</a> </li> <li> <a href="/docs/11.x/upgrade">Upgrade Guide</a> </li> <li> <a href="/docs/11.x/contributions">Contribution Guide</a> </li> </ul> </li> <li> <h2>Getting Started</h2> <ul> <li> <a href="/docs/11.x/installation">Installation</a> </li> <li> <a href="/docs/11.x/configuration">Configuration</a> </li> <li> <a href="/docs/11.x/structure">Directory Structure</a> </li> <li> <a href="/docs/11.x/frontend">Frontend</a> </li> <li> <a href="/docs/11.x/starter-kits">Starter Kits</a> </li> <li> <a href="/docs/11.x/deployment">Deployment</a> </li> </ul> </li> <li> <h2>Architecture Concepts</h2> <ul> <li> <a href="/docs/11.x/lifecycle">Request Lifecycle</a> </li> <li> <a href="/docs/11.x/container">Service Container</a> </li> <li> <a href="/docs/11.x/providers">Service Providers</a> </li> <li> <a href="/docs/11.x/facades">Facades</a> </li> </ul> </li> <li> <h2>The Basics</h2> <ul> <li> <a href="/docs/11.x/routing">Routing</a> </li> <li> <a href="/docs/11.x/middleware">Middleware</a> </li> <li> <a href="/docs/11.x/csrf">CSRF Protection</a> </li> <li> <a href="/docs/11.x/controllers">Controllers</a> </li> <li> <a href="/docs/11.x/requests">Requests</a> </li> <li> <a href="/docs/11.x/responses">Responses</a> </li> <li> <a href="/docs/11.x/views">Views</a> </li> <li> <a href="/docs/11.x/blade">Blade Templates</a> </li> <li> <a href="/docs/11.x/vite">Asset Bundling</a> </li> <li> <a href="/docs/11.x/urls">URL Generation</a> </li> <li> <a href="/docs/11.x/session">Session</a> </li> <li> <a href="/docs/11.x/validation">Validation</a> </li> <li> <a href="/docs/11.x/errors">Error Handling</a> </li> <li> <a href="/docs/11.x/logging">Logging</a> </li> </ul> </li> <li> <h2>Digging Deeper</h2> <ul> <li> <a href="/docs/11.x/artisan">Artisan Console</a> </li> <li> <a href="/docs/11.x/broadcasting">Broadcasting</a> </li> <li> <a href="/docs/11.x/cache">Cache</a> </li> <li> <a href="/docs/11.x/collections">Collections</a> </li> <li> <a href="/docs/11.x/concurrency">Concurrency</a> </li> <li> <a href="/docs/11.x/context">Context</a> </li> <li> <a href="/docs/11.x/contracts">Contracts</a> </li> <li> <a href="/docs/11.x/events">Events</a> </li> <li> <a href="/docs/11.x/filesystem">File Storage</a> </li> <li> <a href="/docs/11.x/helpers">Helpers</a> </li> <li> <a href="/docs/11.x/http-client">HTTP Client</a> </li> <li> <a href="/docs/11.x/localization">Localization</a> </li> <li> <a href="/docs/11.x/mail">Mail</a> </li> <li> <a href="/docs/11.x/notifications">Notifications</a> </li> <li> <a href="/docs/11.x/packages">Package Development</a> </li> <li> <a href="/docs/11.x/processes">Processes</a> </li> <li> <a href="/docs/11.x/queues">Queues</a> </li> <li> <a href="/docs/11.x/rate-limiting">Rate Limiting</a> </li> <li> <a href="/docs/11.x/strings">Strings</a> </li> <li> <a href="/docs/11.x/scheduling">Task Scheduling</a> </li> </ul> </li> <li> <h2>Security</h2> <ul> <li> <a href="/docs/11.x/authentication">Authentication</a> </li> <li> <a href="/docs/11.x/authorization">Authorization</a> </li> <li> <a href="/docs/11.x/verification">Email Verification</a> </li> <li> <a href="/docs/11.x/encryption">Encryption</a> </li> <li> <a href="/docs/11.x/hashing">Hashing</a> </li> <li> <a href="/docs/11.x/passwords">Password Reset</a> </li> </ul> </li> <li> <h2>Database</h2> <ul> <li> <a href="/docs/11.x/database">Getting Started</a> </li> <li> <a href="/docs/11.x/queries">Query Builder</a> </li> <li> <a href="/docs/11.x/pagination">Pagination</a> </li> <li> <a href="/docs/11.x/migrations">Migrations</a> </li> <li> <a href="/docs/11.x/seeding">Seeding</a> </li> <li> <a href="/docs/11.x/redis">Redis</a> </li> <li> <a href="/docs/11.x/mongodb">MongoDB</a> </li> </ul> </li> <li> <h2>Eloquent ORM</h2> <ul> <li> <a href="/docs/11.x/eloquent">Getting Started</a> </li> <li> <a href="/docs/11.x/eloquent-relationships">Relationships</a> </li> <li> <a href="/docs/11.x/eloquent-collections">Collections</a> </li> <li> <a href="/docs/11.x/eloquent-mutators">Mutators / Casts</a> </li> <li> <a href="/docs/11.x/eloquent-resources">API Resources</a> </li> <li> <a href="/docs/11.x/eloquent-serialization">Serialization</a> </li> <li> <a href="/docs/11.x/eloquent-factories">Factories</a> </li> </ul> </li> <li> <h2>Testing</h2> <ul> <li> <a href="/docs/11.x/testing">Getting Started</a> </li> <li> <a href="/docs/11.x/http-tests">HTTP Tests</a> </li> <li> <a href="/docs/11.x/console-tests">Console Tests</a> </li> <li> <a href="/docs/11.x/dusk">Browser Tests</a> </li> <li> <a href="/docs/11.x/database-testing">Database</a> </li> <li> <a href="/docs/11.x/mocking">Mocking</a> </li> </ul> </li> <li class="sub--on"> <h2>Packages</h2> <ul> <li> <a href="/docs/11.x/starter-kits#laravel-breeze">Breeze</a> </li> <li> <a href="/docs/11.x/billing">Cashier (Stripe)</a> </li> <li> <a href="/docs/11.x/cashier-paddle">Cashier (Paddle)</a> </li> <li> <a href="/docs/11.x/dusk">Dusk</a> </li> <li> <a href="/docs/11.x/envoy">Envoy</a> </li> <li> <a href="/docs/11.x/fortify">Fortify</a> </li> <li> <a href="/docs/11.x/folio">Folio</a> </li> <li> <a href="/docs/11.x/homestead">Homestead</a> </li> <li> <a href="/docs/11.x/horizon">Horizon</a> </li> <li> <a href="https://jetstream.laravel.com">Jetstream</a> </li> <li> <a href="/docs/11.x/mix">Mix</a> </li> <li> <a href="/docs/11.x/octane">Octane</a> </li> <li> <a href="/docs/11.x/passport">Passport</a> </li> <li> <a href="/docs/11.x/pennant">Pennant</a> </li> <li> <a href="/docs/11.x/pint">Pint</a> </li> <li> <a href="/docs/11.x/precognition">Precognition</a> </li> <li> <a href="/docs/11.x/prompts">Prompts</a> </li> <li> <a href="/docs/11.x/pulse">Pulse</a> </li> <li> <a href="/docs/11.x/reverb">Reverb</a> </li> <li class="active"> <a href="/docs/11.x/sail">Sail</a> </li> <li> <a href="/docs/11.x/sanctum">Sanctum</a> </li> <li> <a href="/docs/11.x/scout">Scout</a> </li> <li> <a href="/docs/11.x/socialite">Socialite</a> </li> <li> <a href="/docs/11.x/telescope">Telescope</a> </li> <li> <a href="/docs/11.x/valet">Valet</a> </li> </ul> </li> <li> <a href="/api/11.x">API Documentation</a> </li> </ul> </div> </nav> </div> </header> <section class="flex-1 dark:bg-dark-700"> <div class="max-w-screen-lg px-8 sm:px-16 lg:px-24"> <div class="flex flex-col items-end border-b border-gray-200 py-1 transition-colors dark:border-gray-700 lg:mt-8 lg:flex-row-reverse"> <div class="hidden lg:flex items-center justify-center ml-8"> <button id="header__sun" onclick="toSystemMode()" title="Switch to system theme" class="relative w-10 h-10 focus:outline-none focus:shadow-outline text-gray-500"> <svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-sun" width="24" height="24" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"> <path stroke="none" d="M0 0h24v24H0z" fill="none"></path> <circle cx="12" cy="12" r="4"></circle> <path d="M3 12h1m8 -9v1m8 8h1m-9 8v1m-6.4 -15.4l.7 .7m12.1 -.7l-.7 .7m0 11.4l.7 .7m-12.1 -.7l-.7 .7"></path> </svg> </button> <button id="header__moon" onclick="toLightMode()" title="Switch to light mode" class="relative w-10 h-10 focus:outline-none focus:shadow-outline text-gray-500"> <svg style="width:24px;height:24px" viewBox="0 0 24 24"> <path fill="currentColor" d="M17.75,4.09L15.22,6.03L16.13,9.09L13.5,7.28L10.87,9.09L11.78,6.03L9.25,4.09L12.44,4L13.5,1L14.56,4L17.75,4.09M21.25,11L19.61,12.25L20.2,14.23L18.5,13.06L16.8,14.23L17.39,12.25L15.75,11L17.81,10.95L18.5,9L19.19,10.95L21.25,11M18.97,15.95C19.8,15.87 20.69,17.05 20.16,17.8C19.84,18.25 19.5,18.67 19.08,19.07C15.17,23 8.84,23 4.94,19.07C1.03,15.17 1.03,8.83 4.94,4.93C5.34,4.53 5.76,4.17 6.21,3.85C6.96,3.32 8.14,4.21 8.06,5.04C7.79,7.9 8.75,10.87 10.95,13.06C13.14,15.26 16.1,16.22 18.97,15.95M17.33,17.97C14.5,17.81 11.7,16.64 9.53,14.5C7.36,12.31 6.2,9.5 6.04,6.68C3.23,9.82 3.34,14.64 6.35,17.66C9.37,20.67 14.19,20.78 17.33,17.97Z" /> </svg> </button> <button id="header__indeterminate" onclick="toDarkMode()" title="Switch to dark mode" class="relative w-10 h-10 focus:outline-none focus:shadow-outline text-gray-500"> <svg style="width:24px;height:24px" viewBox="0 0 24 24"> <path fill="currentColor" d="M12 2A10 10 0 0 0 2 12A10 10 0 0 0 12 22A10 10 0 0 0 22 12A10 10 0 0 0 12 2M12 4A8 8 0 0 1 20 12A8 8 0 0 1 12 20V4Z" /> </svg> </button> </div> <div class="w-full lg:w-40 lg:pl-12"> <div> <label class="text-gray-600 text-xs tracking-widest uppercase dark:text-gray-500" for="version-switcher">Version</label> <div x-data class="relative w-full bg-white transition-all duration-500 focus-within:border-gray-600 dark:bg-gray-800"> <select id="version-switcher" aria-label="Laravel version" class="appearance-none flex-1 w-full px-0 py-1 placeholder-gray-900 tracking-wide bg-white border-transparent focus:outline-none dark:bg-dark-700 dark:text-gray-400 dark:placeholder-gray-500" @change="window.location = $event.target.value" > <option value="https://laravel.com/docs/master/sail">Master</option> <option selected value="https://laravel.com/docs/11.x/sail">11.x</option> <option value="https://laravel.com/docs/10.x/sail">10.x</option> <option value="https://laravel.com/docs/9.x/sail">9.x</option> <option value="https://laravel.com/docs/8.x/sail">8.x</option> <option value="https://laravel.com/docs/7.x/sail">7.x</option> <option value="https://laravel.com/docs/6.x/sail">6.x</option> <option value="https://laravel.com/docs/5.8/sail">5.8</option> <option value="https://laravel.com/docs/5.7/sail">5.7</option> <option value="https://laravel.com/docs/5.6/sail">5.6</option> <option value="https://laravel.com/docs/5.5/sail">5.5</option> <option value="https://laravel.com/docs/5.4/sail">5.4</option> <option value="https://laravel.com/docs/5.3/sail">5.3</option> <option value="https://laravel.com/docs/5.2/sail">5.2</option> <option value="https://laravel.com/docs/5.1/sail">5.1</option> <option value="https://laravel.com/docs/5.0/sail">5.0</option> <option value="https://laravel.com/docs/4.2/sail">4.2</option> </select> <img class="absolute inset-y-0 right-0 mt-2.5 w-2.5 h-2.5 text-gray-900 pointer-events-none dark:hidden" src="/img/icons/drop_arrow.min.svg" alt="" width="10" height="10"> <img class="absolute inset-y-0 right-0 mt-2.5 w-2.5 h-2.5 text-gray-900 pointer-events-none hidden dark:block" src="/img/icons/drop_arrow.dark.min.svg" alt="" width="10" height="10"> </div> </div> </div> <div class="relative mt-8 flex items-center justify-end w-full h-10 lg:mt-0"> <div class="flex-1 flex items-center"> <button id="docsearch" class="text-gray-800 transition-colors dark:text-gray-400 w-full"></button> </div> </div> </div> <section class="mt-8 md:mt-16"> <section class="docs_main max-w-prose"> <div id="main-content"> <h1>Laravel Sail</h1> <ul> <li> <a href="#introduction">Introduction</a> </li> <li> <a href="#installation">Installation and Setup</a> <ul> <li> <a href="#installing-sail-into-existing-applications">Installing Sail Into Existing Applications</a> </li> <li> <a href="#rebuilding-sail-images">Rebuilding Sail Images</a> </li> <li> <a href="#configuring-a-shell-alias">Configuring A Shell Alias</a> </li> </ul> </li> <li> <a href="#starting-and-stopping-sail">Starting and Stopping Sail</a> </li> <li> <a href="#executing-sail-commands">Executing Commands</a> <ul> <li> <a href="#executing-php-commands">Executing PHP Commands</a> </li> <li> <a href="#executing-composer-commands">Executing Composer Commands</a> </li> <li> <a href="#executing-artisan-commands">Executing Artisan Commands</a> </li> <li> <a href="#executing-node-npm-commands">Executing Node / NPM Commands</a> </li> </ul> </li> <li> <a href="#interacting-with-sail-databases">Interacting With Databases</a> <ul> <li> <a href="#mysql">MySQL</a> </li> <li> <a href="#mongodb">MongoDB</a> </li> <li> <a href="#redis">Redis</a> </li> <li> <a href="#valkey">Valkey</a> </li> <li> <a href="#meilisearch">Meilisearch</a> </li> <li> <a href="#typesense">Typesense</a> </li> </ul> </li> <li> <a href="#file-storage">File Storage</a> </li> <li> <a href="#running-tests">Running Tests</a> <ul> <li> <a href="#laravel-dusk">Laravel Dusk</a> </li> </ul> </li> <li> <a href="#previewing-emails">Previewing Emails</a> </li> <li> <a href="#sail-container-cli">Container CLI</a> </li> <li> <a href="#sail-php-versions">PHP Versions</a> </li> <li> <a href="#sail-node-versions">Node Versions</a> </li> <li> <a href="#sharing-your-site">Sharing Your Site</a> </li> <li> <a href="#debugging-with-xdebug">Debugging With Xdebug</a> <ul> <li> <a href="#xdebug-cli-usage">Xdebug CLI Usage</a> </li> <li> <a href="#xdebug-browser-usage">Xdebug Browser Usage</a> </li> </ul> </li> <li> <a href="#sail-customization">Customization</a> </li> </ul> <h2 id="introduction"><a href="#introduction">Introduction</a></h2> <p><a href="https://github.com/laravel/sail">Laravel Sail</a> is a light-weight command-line interface for interacting with Laravel's default Docker development environment. Sail provides a great starting point for building a Laravel application using PHP, MySQL, and Redis without requiring prior Docker experience.</p> <p>At its heart, Sail is the <code>docker-compose.yml</code> file and the <code>sail</code> script that is stored at the root of your project. The <code>sail</code> script provides a CLI with convenient methods for interacting with the Docker containers defined by the <code>docker-compose.yml</code> file.</p> <p>Laravel Sail is supported on macOS, Linux, and Windows (via <a href="https://docs.microsoft.com/en-us/windows/wsl/about">WSL2</a>).</p> <h2 id="installation"><a href="#installation">Installation and Setup</a></h2> <p>Laravel Sail is automatically installed with all new Laravel applications so you may start using it immediately. To learn how to create a new Laravel application, please consult Laravel's <a href="/docs/11.x/installation#docker-installation-using-sail">installation documentation</a> for your operating system. During installation, you will be asked to choose which Sail supported services your application will be interacting with.</p> <h3 id="installing-sail-into-existing-applications"><a href="#installing-sail-into-existing-applications">Installing Sail Into Existing Applications</a></h3> <p>If you are interested in using Sail with an existing Laravel application, you may simply install Sail using the Composer package manager. Of course, these steps assume that your existing local development environment allows you to install Composer dependencies:</p> <div class="code-container"> <pre><code data-theme="olaolu-palenight" data-lang="shell" class='torchlight' style='background-color: #292D3E; --theme-selection-background: #7580B850;'><div class='line'><span style="color: #BFC7D5;">composer </span><span style="color: #BFC7D5;">require</span><span style="color: #BFC7D5;"> </span><span style="color: #BFC7D5;">laravel/sail</span><span style="color: #BFC7D5;"> </span><span style="color: #82AAFF;">--dev</span></div></code></pre> </div> <p>After Sail has been installed, you may run the <code>sail:install</code> Artisan command. This command will publish Sail's <code>docker-compose.yml</code> file to the root of your application and modify your <code>.env</code> file with the required environment variables in order to connect to the Docker services:</p> <div class="code-container"> <pre><code data-theme="olaolu-palenight" data-lang="shell" class='torchlight' style='background-color: #292D3E; --theme-selection-background: #7580B850;'><div class='line'><span style="color: #BFC7D5;">php </span><span style="color: #BFC7D5;">artisan</span><span style="color: #BFC7D5;"> </span><span style="color: #BFC7D5;">sail:install</span></div></code></pre> </div> <p>Finally, you may start Sail. To continue learning how to use Sail, please continue reading the remainder of this documentation:</p> <div class="code-container"> <pre><code data-theme="olaolu-palenight" data-lang="shell" class='torchlight' style='background-color: #292D3E; --theme-selection-background: #7580B850;'><div class='line'><span style="color: #BFC7D5;">./vendor/bin/sail </span><span style="color: #BFC7D5;">up</span></div></code></pre> </div> <div class="mb-10 max-w-2xl mx-auto px-4 py-8 shadow-lg lg:flex lg:items-center callout"> <div class="w-20 h-20 mb-6 flex items-center justify-center shrink-0 lg:mb-0 bg-red-600"> <div class="opacity-75"><svg width="6" height="35" viewBox="0 0 6 35" xmlns="http://www.w3.org/2000/svg"><title>exclamation</title><path d="M0 29h6v6H0v-6zM0 0h6v24H0V0z" fill="#FFF" fill-rule="nonzero"/></svg> </div> </div> <p class="mb-0 lg:ml-6 callout"> If you are using Docker Desktop for Linux, you should use the <code>default</code> Docker context by executing the following command: <code>docker context use default</code>.</p> </div> <h4 id="adding-additional-services"><a href="#adding-additional-services">Adding Additional Services</a></h4> <p>If you would like to add an additional service to your existing Sail installation, you may run the <code>sail:add</code> Artisan command:</p> <div class="code-container"> <pre><code data-theme="olaolu-palenight" data-lang="shell" class='torchlight' style='background-color: #292D3E; --theme-selection-background: #7580B850;'><div class='line'><span style="color: #BFC7D5;">php </span><span style="color: #BFC7D5;">artisan</span><span style="color: #BFC7D5;"> </span><span style="color: #BFC7D5;">sail:add</span></div></code></pre> </div> <h4 id="using-devcontainers"><a href="#using-devcontainers">Using Devcontainers</a></h4> <p>If you would like to develop within a <a href="https://code.visualstudio.com/docs/remote/containers">Devcontainer</a>, you may provide the <code>--devcontainer</code> option to the <code>sail:install</code> command. The <code>--devcontainer</code> option will instruct the <code>sail:install</code> command to publish a default <code>.devcontainer/devcontainer.json </code> file to the root of your application:</p> <div class="code-container"> <pre><code data-theme="olaolu-palenight" data-lang="shell" class='torchlight' style='background-color: #292D3E; --theme-selection-background: #7580B850;'><div class='line'><span style="color: #BFC7D5;">php </span><span style="color: #BFC7D5;">artisan</span><span style="color: #BFC7D5;"> </span><span style="color: #BFC7D5;">sail:install</span><span style="color: #BFC7D5;"> </span><span style="color: #82AAFF;">--devcontainer</span></div></code></pre> </div> <h3 id="rebuilding-sail-images"><a href="#rebuilding-sail-images">Rebuilding Sail Images</a></h3> <p>Sometimes you may want to completely rebuild your Sail images to ensure all of the image's packages and software are up to date. You may accomplish this using the <code>build</code> command:</p> <div class="code-container"> <pre><code data-theme="olaolu-palenight" data-lang="shell" class='torchlight' style='background-color: #292D3E; --theme-selection-background: #7580B850;'><div class='line'><span style="color: #BFC7D5;">docker </span><span style="color: #BFC7D5;">compose</span><span style="color: #BFC7D5;"> </span><span style="color: #BFC7D5;">down</span><span style="color: #BFC7D5;"> </span><span style="color: #82AAFF;">-v</span></div><div class='line'> </div><div class='line'><span style="color: #BFC7D5;">sail </span><span style="color: #BFC7D5;">build</span><span style="color: #BFC7D5;"> </span><span style="color: #82AAFF;">--no-cache</span></div><div class='line'> </div><div class='line'><span style="color: #BFC7D5;">sail </span><span style="color: #BFC7D5;">up</span></div></code></pre> </div> <h3 id="configuring-a-shell-alias"><a href="#configuring-a-shell-alias">Configuring A Shell Alias</a></h3> <p>By default, Sail commands are invoked using the <code>vendor/bin/sail</code> script that is included with all new Laravel applications:</p> <div class="code-container"> <pre><code data-theme="olaolu-palenight" data-lang="shell" class='torchlight' style='background-color: #292D3E; --theme-selection-background: #7580B850;'><div class='line'><span style="color: #BFC7D5;">./vendor/bin/sail </span><span style="color: #BFC7D5;">up</span></div></code></pre> </div> <p>However, instead of repeatedly typing <code>vendor/bin/sail</code> to execute Sail commands, you may wish to configure a shell alias that allows you to execute Sail's commands more easily:</p> <div class="code-container"> <pre><code data-theme="olaolu-palenight" data-lang="shell" class='torchlight' style='background-color: #292D3E; --theme-selection-background: #7580B850;'><div class='line'><span style="color: #C792EA;">alias</span><span style="color: #BFC7D5;"> </span><span style="color: #FFCB6B;">sail</span><span style="color: #C792EA;">=</span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">sh $([ -f sail ] && echo sail || echo vendor/bin/sail)</span><span style="color: #D9F5DD;">'</span></div></code></pre> </div> <p>To make sure this is always available, you may add this to your shell configuration file in your home directory, such as <code>~/.zshrc</code> or <code>~/.bashrc</code>, and then restart your shell.</p> <p>Once the shell alias has been configured, you may execute Sail commands by simply typing <code>sail</code>. The remainder of this documentation's examples will assume that you have configured this alias:</p> <div class="code-container"> <pre><code data-theme="olaolu-palenight" data-lang="shell" class='torchlight' style='background-color: #292D3E; --theme-selection-background: #7580B850;'><div class='line'><span style="color: #BFC7D5;">sail </span><span style="color: #BFC7D5;">up</span></div></code></pre> </div> <h2 id="starting-and-stopping-sail"><a href="#starting-and-stopping-sail">Starting and Stopping Sail</a></h2> <p>Laravel Sail's <code>docker-compose.yml</code> file defines a variety of Docker containers that work together to help you build Laravel applications. Each of these containers is an entry within the <code>services</code> configuration of your <code>docker-compose.yml</code> file. The <code>laravel.test</code> container is the primary application container that will be serving your application.</p> <p>Before starting Sail, you should ensure that no other web servers or databases are running on your local computer. To start all of the Docker containers defined in your application's <code>docker-compose.yml</code> file, you should execute the <code>up</code> command:</p> <div class="code-container"> <pre><code data-theme="olaolu-palenight" data-lang="shell" class='torchlight' style='background-color: #292D3E; --theme-selection-background: #7580B850;'><div class='line'><span style="color: #BFC7D5;">sail </span><span style="color: #BFC7D5;">up</span></div></code></pre> </div> <p>To start all of the Docker containers in the background, you may start Sail in "detached" mode:</p> <div class="code-container"> <pre><code data-theme="olaolu-palenight" data-lang="shell" class='torchlight' style='background-color: #292D3E; --theme-selection-background: #7580B850;'><div class='line'><span style="color: #BFC7D5;">sail </span><span style="color: #BFC7D5;">up</span><span style="color: #BFC7D5;"> </span><span style="color: #82AAFF;">-d</span></div></code></pre> </div> <p>Once the application's containers have been started, you may access the project in your web browser at: <a href="http://localhost">http://localhost</a>.</p> <p>To stop all of the containers, you may simply press Control + C to stop the container's execution. Or, if the containers are running in the background, you may use the <code>stop</code> command:</p> <div class="code-container"> <pre><code data-theme="olaolu-palenight" data-lang="shell" class='torchlight' style='background-color: #292D3E; --theme-selection-background: #7580B850;'><div class='line'><span style="color: #BFC7D5;">sail </span><span style="color: #BFC7D5;">stop</span></div></code></pre> </div> <h2 id="executing-sail-commands"><a href="#executing-sail-commands">Executing Commands</a></h2> <p>When using Laravel Sail, your application is executing within a Docker container and is isolated from your local computer. However, Sail provides a convenient way to run various commands against your application such as arbitrary PHP commands, Artisan commands, Composer commands, and Node / NPM commands.</p> <p><strong>When reading the Laravel documentation, you will often see references to Composer, Artisan, and Node / NPM commands that do not reference Sail.</strong> Those examples assume that these tools are installed on your local computer. If you are using Sail for your local Laravel development environment, you should execute those commands using Sail:</p> <div class="code-container"> <pre><code data-theme="olaolu-palenight" data-lang="shell" class='torchlight' style='background-color: #292D3E; --theme-selection-background: #7580B850;'><div class='line'><span style="color: #697098;">#</span><span style="color: #697098;"> Running Artisan commands locally...</span></div><div class='line'><span style="color: #BFC7D5;">php </span><span style="color: #BFC7D5;">artisan</span><span style="color: #BFC7D5;"> </span><span style="color: #BFC7D5;">queue:work</span></div><div class='line'> </div><div class='line'><span style="color: #697098;">#</span><span style="color: #697098;"> Running Artisan commands within Laravel Sail...</span></div><div class='line'><span style="color: #BFC7D5;">sail </span><span style="color: #BFC7D5;">artisan</span><span style="color: #BFC7D5;"> </span><span style="color: #BFC7D5;">queue:work</span></div></code></pre> </div> <h3 id="executing-php-commands"><a href="#executing-php-commands">Executing PHP Commands</a></h3> <p>PHP commands may be executed using the <code>php</code> command. Of course, these commands will execute using the PHP version that is configured for your application. To learn more about the PHP versions available to Laravel Sail, consult the <a href="#sail-php-versions">PHP version documentation</a>:</p> <div class="code-container"> <pre><code data-theme="olaolu-palenight" data-lang="shell" class='torchlight' style='background-color: #292D3E; --theme-selection-background: #7580B850;'><div class='line'><span style="color: #BFC7D5;">sail </span><span style="color: #BFC7D5;">php</span><span style="color: #BFC7D5;"> </span><span style="color: #82AAFF;">--version</span></div><div class='line'> </div><div class='line'><span style="color: #BFC7D5;">sail </span><span style="color: #BFC7D5;">php</span><span style="color: #BFC7D5;"> </span><span style="color: #BFC7D5;">script.php</span></div></code></pre> </div> <h3 id="executing-composer-commands"><a href="#executing-composer-commands">Executing Composer Commands</a></h3> <p>Composer commands may be executed using the <code>composer</code> command. Laravel Sail's application container includes a Composer installation:</p> <div class="code-container"> <pre><code data-theme="olaolu-palenight" data-lang="shell" class='torchlight' style='background-color: #292D3E; --theme-selection-background: #7580B850;'><div class='line'><span style="color: #BFC7D5;">sail </span><span style="color: #BFC7D5;">composer</span><span style="color: #BFC7D5;"> </span><span style="color: #BFC7D5;">require</span><span style="color: #BFC7D5;"> </span><span style="color: #BFC7D5;">laravel/sanctum</span></div></code></pre> </div> <h4 id="installing-composer-dependencies-for-existing-projects"><a href="#installing-composer-dependencies-for-existing-projects">Installing Composer Dependencies for Existing Applications</a></h4> <p>If you are developing an application with a team, you may not be the one that initially creates the Laravel application. Therefore, none of the application's Composer dependencies, including Sail, will be installed after you clone the application's repository to your local computer.</p> <p>You may install the application's dependencies by navigating to the application's directory and executing the following command. This command uses a small Docker container containing PHP and Composer to install the application's dependencies:</p> <div class="code-container"> <pre><code data-theme="olaolu-palenight" data-lang="shell" class='torchlight' style='background-color: #292D3E; --theme-selection-background: #7580B850;'><div class='line'><span style="color: #BFC7D5;">docker </span><span style="color: #BFC7D5;">run</span><span style="color: #BFC7D5;"> </span><span style="color: #82AAFF;">--rm</span><span style="color: #BFC7D5;"> </span><span style="color: #F78C6C;">\</span></div><div class='line'><span style="color: #BFC7D5;"> -u </span><span style="color: #D9F5DD;">"</span><span style="color: #C3E88D;">$(id </span><span style="color: #82AAFF;">-u</span><span style="color: #C3E88D;">):$(id </span><span style="color: #82AAFF;">-g</span><span style="color: #C3E88D;">)</span><span style="color: #D9F5DD;">"</span><span style="color: #BFC7D5;"> </span><span style="color: #F78C6C;">\</span></div><div class='line'><span style="color: #BFC7D5;"> -v </span><span style="color: #D9F5DD;">"</span><span style="color: #C3E88D;">$(pwd):/var/www/html</span><span style="color: #D9F5DD;">"</span><span style="color: #BFC7D5;"> </span><span style="color: #F78C6C;">\</span></div><div class='line'><span style="color: #BFC7D5;"> -w </span><span style="color: #BFC7D5;">/var/www/html</span><span style="color: #BFC7D5;"> </span><span style="color: #F78C6C;">\</span></div><div class='line'><span style="color: #BFC7D5;"> laravelsail/php84-composer:latest </span><span style="color: #F78C6C;">\</span></div><div class='line'><span style="color: #BFC7D5;"> composer </span><span style="color: #BFC7D5;">install</span><span style="color: #BFC7D5;"> </span><span style="color: #82AAFF;">--ignore-platform-reqs</span></div></code></pre> </div> <p>When using the <code>laravelsail/phpXX-composer</code> image, you should use the same version of PHP that you plan to use for your application (<code>80</code>, <code>81</code>, <code>82</code>, <code>83</code>, or <code>84</code>).</p> <h3 id="executing-artisan-commands"><a href="#executing-artisan-commands">Executing Artisan Commands</a></h3> <p>Laravel Artisan commands may be executed using the <code>artisan</code> command:</p> <div class="code-container"> <pre><code data-theme="olaolu-palenight" data-lang="shell" class='torchlight' style='background-color: #292D3E; --theme-selection-background: #7580B850;'><div class='line'><span style="color: #BFC7D5;">sail </span><span style="color: #BFC7D5;">artisan</span><span style="color: #BFC7D5;"> </span><span style="color: #BFC7D5;">queue:work</span></div></code></pre> </div> <h3 id="executing-node-npm-commands"><a href="#executing-node-npm-commands">Executing Node / NPM Commands</a></h3> <p>Node commands may be executed using the <code>node</code> command while NPM commands may be executed using the <code>npm</code> command:</p> <div class="code-container"> <pre><code data-theme="olaolu-palenight" data-lang="shell" class='torchlight' style='background-color: #292D3E; --theme-selection-background: #7580B850;'><div class='line'><span style="color: #BFC7D5;">sail </span><span style="color: #BFC7D5;">node</span><span style="color: #BFC7D5;"> </span><span style="color: #82AAFF;">--version</span></div><div class='line'> </div><div class='line'><span style="color: #BFC7D5;">sail </span><span style="color: #BFC7D5;">npm</span><span style="color: #BFC7D5;"> </span><span style="color: #BFC7D5;">run</span><span style="color: #BFC7D5;"> </span><span style="color: #BFC7D5;">dev</span></div></code></pre> </div> <p>If you wish, you may use Yarn instead of NPM:</p> <div class="code-container"> <pre><code data-theme="olaolu-palenight" data-lang="shell" class='torchlight' style='background-color: #292D3E; --theme-selection-background: #7580B850;'><div class='line'><span style="color: #BFC7D5;">sail </span><span style="color: #BFC7D5;">yarn</span></div></code></pre> </div> <h2 id="interacting-with-sail-databases"><a href="#interacting-with-sail-databases">Interacting With Databases</a></h2> <h3 id="mysql"><a href="#mysql">MySQL</a></h3> <p>As you may have noticed, your application's <code>docker-compose.yml</code> file contains an entry for a MySQL container. This container uses a <a href="https://docs.docker.com/storage/volumes/">Docker volume</a> so that the data stored in your database is persisted even when stopping and restarting your containers.</p> <p>In addition, the first time the MySQL container starts, it will create two databases for you. The first database is named using the value of your <code>DB_DATABASE</code> environment variable and is for your local development. The second is a dedicated testing database named <code>testing</code> and will ensure that your tests do not interfere with your development data.</p> <p>Once you have started your containers, you may connect to the MySQL instance within your application by setting your <code>DB_HOST</code> environment variable within your application's <code>.env</code> file to <code>mysql</code>.</p> <p>To connect to your application's MySQL database from your local machine, you may use a graphical database management application such as <a href="https://tableplus.com">TablePlus</a>. By default, the MySQL database is accessible at <code>localhost</code> port 3306 and the access credentials correspond to the values of your <code>DB_USERNAME</code> and <code>DB_PASSWORD</code> environment variables. Or, you may connect as the <code>root</code> user, which also utilizes the value of your <code>DB_PASSWORD</code> environment variable as its password.</p> <h3 id="mongodb"><a href="#mongodb">MongoDB</a></h3> <p>If you chose to install the <a href="https://www.mongodb.com/">MongoDB</a> service when installing Sail, your application's <code>docker-compose.yml</code> file contains an entry for a <a href="https://www.mongodb.com/docs/atlas/cli/current/atlas-cli-local-cloud/">MongoDB Atlas Local</a> container which provides the MongoDB document database with Atlas features like <a href="https://www.mongodb.com/docs/atlas/atlas-search/">Search Indexes</a>. This container uses a <a href="https://docs.docker.com/storage/volumes/">Docker volume</a> so that the data stored in your database is persisted even when stopping and restarting your containers.</p> <p>Once you have started your containers, you may connect to the MongoDB instance within your application by setting your <code>MONGODB_URI</code> environment variable within your application's <code>.env</code> file to <code>mongodb://mongodb:27017</code>. Authentication is disabled by default, but you can set the <code>MONGODB_USERNAME</code> and <code>MONGODB_PASSWORD</code> environment variables to enable authentication before starting the <code>mongodb</code> container. Then, add the credentials to the connection string:</p> <div class="code-container"> <pre><code data-theme="olaolu-palenight" data-lang="ini" class='torchlight' style='background-color: #292D3E; --theme-selection-background: #7580B850;'><div class='line'><span style="color: #C792EA;">MONGODB_USERNAME</span><span style="color: #BFC7D5;">=user</span></div><div class='line'><span style="color: #C792EA;">MONGODB_PASSWORD</span><span style="color: #BFC7D5;">=laravel</span></div><div class='line'><span style="color: #C792EA;">MONGODB_URI</span><span style="color: #BFC7D5;">=mongodb://${MONGODB_USERNAME}:${MONGODB_PASSWORD}@mongodb:27017</span></div></code></pre> </div> <p>For seamless integration of MongoDB with your application, you can install the <a href="https://www.mongodb.com/docs/drivers/php/laravel-mongodb/">official package maintained by MongoDB</a>.</p> <p>To connect to your application's MongoDB database from your local machine, you may use a graphical interface such as <a href="https://www.mongodb.com/products/tools/compass">Compass</a>. By default, the MongoDB database is accessible at <code>localhost</code> port <code>27017</code>.</p> <h3 id="redis"><a href="#redis">Redis</a></h3> <p>Your application's <code>docker-compose.yml</code> file also contains an entry for a <a href="https://redis.io">Redis</a> container. This container uses a <a href="https://docs.docker.com/storage/volumes/">Docker volume</a> so that the data stored in your Redis instance is persisted even when stopping and restarting your containers. Once you have started your containers, you may connect to the Redis instance within your application by setting your <code>REDIS_HOST</code> environment variable within your application's <code>.env</code> file to <code>redis</code>.</p> <p>To connect to your application's Redis database from your local machine, you may use a graphical database management application such as <a href="https://tableplus.com">TablePlus</a>. By default, the Redis database is accessible at <code>localhost</code> port 6379.</p> <h3 id="valkey"><a href="#valkey">Valkey</a></h3> <p>If you choose to install Valkey service when installing Sail, your application's <code>docker-compose.yml</code> file will contain an entry for <a href="https://valkey.io/">Valkey</a>. This container uses a <a href="https://docs.docker.com/storage/volumes/">Docker volume</a> so that the data stored in your Valkey instance is persisted even when stopping and restarting your containers. You can connect to this container in you application by setting your <code>REDIS_HOST</code> environment variable within your application's <code>.env</code> file to <code>valkey</code>.</p> <p>To connect to your application's Valkey database from your local machine, you may use a graphical database management application such as <a href="https://tableplus.com">TablePlus</a>. By default, the Valkey database is accessible at <code>localhost</code> port 6379.</p> <h3 id="meilisearch"><a href="#meilisearch">Meilisearch</a></h3> <p>If you chose to install the <a href="https://www.meilisearch.com">Meilisearch</a> service when installing Sail, your application's <code>docker-compose.yml</code> file will contain an entry for this powerful search engine that is integrated with <a href="/docs/11.x/scout">Laravel Scout</a>. Once you have started your containers, you may connect to the Meilisearch instance within your application by setting your <code>MEILISEARCH_HOST</code> environment variable to <code>http://meilisearch:7700</code>.</p> <p>From your local machine, you may access Meilisearch's web based administration panel by navigating to <code>http://localhost:7700</code> in your web browser.</p> <h3 id="typesense"><a href="#typesense">Typesense</a></h3> <p>If you chose to install the <a href="https://typesense.org">Typesense</a> service when installing Sail, your application's <code>docker-compose.yml</code> file will contain an entry for this lightning fast, open-source search engine that is natively integrated with <a href="/docs/11.x/scout#typesense">Laravel Scout</a>. Once you have started your containers, you may connect to the Typesense instance within your application by setting the following environment variables:</p> <div class="code-container"> <pre><code data-theme="olaolu-palenight" data-lang="ini" class='torchlight' style='background-color: #292D3E; --theme-selection-background: #7580B850;'><div class='line'><span style="color: #C792EA;">TYPESENSE_HOST</span><span style="color: #BFC7D5;">=typesense</span></div><div class='line'><span style="color: #C792EA;">TYPESENSE_PORT</span><span style="color: #BFC7D5;">=8108</span></div><div class='line'><span style="color: #C792EA;">TYPESENSE_PROTOCOL</span><span style="color: #BFC7D5;">=http</span></div><div class='line'><span style="color: #C792EA;">TYPESENSE_API_KEY</span><span style="color: #BFC7D5;">=xyz</span></div></code></pre> </div> <p>From your local machine, you may access Typesense's API via <code>http://localhost:8108</code>.</p> <h2 id="file-storage"><a href="#file-storage">File Storage</a></h2> <p>If you plan to use Amazon S3 to store files while running your application in its production environment, you may wish to install the <a href="https://min.io">MinIO</a> service when installing Sail. MinIO provides an S3 compatible API that you may use to develop locally using Laravel's <code>s3</code> file storage driver without creating "test" storage buckets in your production S3 environment. If you choose to install MinIO while installing Sail, a MinIO configuration section will be added to your application's <code>docker-compose.yml</code> file.</p> <p>By default, your application's <code>filesystems</code> configuration file already contains a disk configuration for the <code>s3</code> disk. In addition to using this disk to interact with Amazon S3, you may use it to interact with any S3 compatible file storage service such as MinIO by simply modifying the associated environment variables that control its configuration. For example, when using MinIO, your filesystem environment variable configuration should be defined as follows:</p> <div class="code-container"> <pre><code data-theme="olaolu-palenight" data-lang="ini" class='torchlight' style='background-color: #292D3E; --theme-selection-background: #7580B850;'><div class='line'><span style="color: #C792EA;">FILESYSTEM_DISK</span><span style="color: #BFC7D5;">=s3</span></div><div class='line'><span style="color: #C792EA;">AWS_ACCESS_KEY_ID</span><span style="color: #BFC7D5;">=sail</span></div><div class='line'><span style="color: #C792EA;">AWS_SECRET_ACCESS_KEY</span><span style="color: #BFC7D5;">=password</span></div><div class='line'><span style="color: #C792EA;">AWS_DEFAULT_REGION</span><span style="color: #BFC7D5;">=us-east-1</span></div><div class='line'><span style="color: #C792EA;">AWS_BUCKET</span><span style="color: #BFC7D5;">=local</span></div><div class='line'><span style="color: #C792EA;">AWS_ENDPOINT</span><span style="color: #BFC7D5;">=http://minio:9000</span></div><div class='line'><span style="color: #C792EA;">AWS_USE_PATH_STYLE_ENDPOINT</span><span style="color: #BFC7D5;">=true</span></div></code></pre> </div> <p>In order for Laravel's Flysystem integration to generate proper URLs when using MinIO, you should define the <code>AWS_URL</code> environment variable so that it matches your application's local URL and includes the bucket name in the URL path:</p> <div class="code-container"> <pre><code data-theme="olaolu-palenight" data-lang="ini" class='torchlight' style='background-color: #292D3E; --theme-selection-background: #7580B850;'><div class='line'><span style="color: #C792EA;">AWS_URL</span><span style="color: #BFC7D5;">=http://localhost:9000/local</span></div></code></pre> </div> <p>You may create buckets via the MinIO console, which is available at <code>http://localhost:8900</code>. The default username for the MinIO console is <code>sail</code> while the default password is <code>password</code>.</p> <div class="mb-10 max-w-2xl mx-auto px-4 py-8 shadow-lg lg:flex lg:items-center callout"> <div class="w-20 h-20 mb-6 flex items-center justify-center shrink-0 lg:mb-0 bg-red-600"> <div class="opacity-75"><svg width="6" height="35" viewBox="0 0 6 35" xmlns="http://www.w3.org/2000/svg"><title>exclamation</title><path d="M0 29h6v6H0v-6zM0 0h6v24H0V0z" fill="#FFF" fill-rule="nonzero"/></svg> </div> </div> <p class="mb-0 lg:ml-6 callout"> Generating temporary storage URLs via the <code>temporaryUrl</code> method is not supported when using MinIO.</p> </div> <h2 id="running-tests"><a href="#running-tests">Running Tests</a></h2> <p>Laravel provides amazing testing support out of the box, and you may use Sail's <code>test</code> command to run your applications <a href="/docs/11.x/testing">feature and unit tests</a>. Any CLI options that are accepted by Pest / PHPUnit may also be passed to the <code>test</code> command:</p> <div class="code-container"> <pre><code data-theme="olaolu-palenight" data-lang="shell" class='torchlight' style='background-color: #292D3E; --theme-selection-background: #7580B850;'><div class='line'><span style="color: #BFC7D5;">sail </span><span style="color: #BFC7D5;">test</span></div><div class='line'> </div><div class='line'><span style="color: #BFC7D5;">sail </span><span style="color: #BFC7D5;">test</span><span style="color: #BFC7D5;"> </span><span style="color: #82AAFF;">--group</span><span style="color: #BFC7D5;"> </span><span style="color: #BFC7D5;">orders</span></div></code></pre> </div> <p>The Sail <code>test</code> command is equivalent to running the <code>test</code> Artisan command:</p> <div class="code-container"> <pre><code data-theme="olaolu-palenight" data-lang="shell" class='torchlight' style='background-color: #292D3E; --theme-selection-background: #7580B850;'><div class='line'><span style="color: #BFC7D5;">sail </span><span style="color: #BFC7D5;">artisan</span><span style="color: #BFC7D5;"> </span><span style="color: #BFC7D5;">test</span></div></code></pre> </div> <p>By default, Sail will create a dedicated <code>testing</code> database so that your tests do not interfere with the current state of your database. In a default Laravel installation, Sail will also configure your <code>phpunit.xml</code> file to use this database when executing your tests:</p> <div class="code-container"> <pre><code data-theme="olaolu-palenight" data-lang="xml" class='torchlight' style='background-color: #292D3E; --theme-selection-background: #7580B850;'><div class='line'><span style="color: #89DDFF;"><</span><span style="color: #FF5572;">env</span><span style="color: #89DDFF;"> </span><span style="color: #FFCB6B;">name</span><span style="color: #89DDFF;">=</span><span style="color: #D9F5DD;">"</span><span style="color: #C3E88D;">DB_DATABASE</span><span style="color: #D9F5DD;">"</span><span style="color: #89DDFF;"> </span><span style="color: #FFCB6B;">value</span><span style="color: #89DDFF;">=</span><span style="color: #D9F5DD;">"</span><span style="color: #C3E88D;">testing</span><span style="color: #D9F5DD;">"</span><span style="color: #89DDFF;">/></span></div></code></pre> </div> <h3 id="laravel-dusk"><a href="#laravel-dusk">Laravel Dusk</a></h3> <p><a href="/docs/11.x/dusk">Laravel Dusk</a> provides an expressive, easy-to-use browser automation and testing API. Thanks to Sail, you may run these tests without ever installing Selenium or other tools on your local computer. To get started, uncomment the Selenium service in your application's <code>docker-compose.yml</code> file:</p> <div class="code-container"> <pre><code data-theme="olaolu-palenight" data-lang="yaml" class='torchlight' style='background-color: #292D3E; --theme-selection-background: #7580B850;'><div class='line'><span style="color: #89DDFF;">selenium</span><span style="color: #BFC7D5;">:</span></div><div class='line'><span style="color: #BFC7D5;"> </span><span style="color: #89DDFF;">image</span><span style="color: #BFC7D5;">: </span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">selenium/standalone-chrome</span><span style="color: #D9F5DD;">'</span></div><div class='line'><span style="color: #BFC7D5;"> </span><span style="color: #89DDFF;">extra_hosts</span><span style="color: #BFC7D5;">:</span></div><div class='line'><span style="color: #BFC7D5;"> - </span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">host.docker.internal:host-gateway</span><span style="color: #D9F5DD;">'</span></div><div class='line'><span style="color: #BFC7D5;"> </span><span style="color: #89DDFF;">volumes</span><span style="color: #BFC7D5;">:</span></div><div class='line'><span style="color: #BFC7D5;"> - </span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">/dev/shm:/dev/shm</span><span style="color: #D9F5DD;">'</span></div><div class='line'><span style="color: #BFC7D5;"> </span><span style="color: #89DDFF;">networks</span><span style="color: #BFC7D5;">:</span></div><div class='line'><span style="color: #BFC7D5;"> - </span><span style="color: #BFC7D5;">sail</span></div></code></pre> </div> <p>Next, ensure that the <code>laravel.test</code> service in your application's <code>docker-compose.yml</code> file has a <code>depends_on</code> entry for <code>selenium</code>:</p> <div class="code-container"> <pre><code data-theme="olaolu-palenight" data-lang="yaml" class='torchlight' style='background-color: #292D3E; --theme-selection-background: #7580B850;'><div class='line'><span style="color: #89DDFF;">depends_on</span><span style="color: #BFC7D5;">:</span></div><div class='line'><span style="color: #BFC7D5;"> - </span><span style="color: #BFC7D5;">mysql</span></div><div class='line'><span style="color: #BFC7D5;"> - </span><span style="color: #BFC7D5;">redis</span></div><div class='line'><span style="color: #BFC7D5;"> - </span><span style="color: #BFC7D5;">selenium</span></div></code></pre> </div> <p>Finally, you may run your Dusk test suite by starting Sail and running the <code>dusk</code> command:</p> <div class="code-container"> <pre><code data-theme="olaolu-palenight" data-lang="shell" class='torchlight' style='background-color: #292D3E; --theme-selection-background: #7580B850;'><div class='line'><span style="color: #BFC7D5;">sail </span><span style="color: #BFC7D5;">dusk</span></div></code></pre> </div> <h4 id="selenium-on-apple-silicon"><a href="#selenium-on-apple-silicon">Selenium on Apple Silicon</a></h4> <p>If your local machine contains an Apple Silicon chip, your <code>selenium</code> service must use the <code>selenium/standalone-chromium</code> image:</p> <div class="code-container"> <pre><code data-theme="olaolu-palenight" data-lang="yaml" class='torchlight' style='background-color: #292D3E; --theme-selection-background: #7580B850;'><div class='line'><span style="color: #89DDFF;">selenium</span><span style="color: #BFC7D5;">:</span></div><div class='line'><span style="color: #BFC7D5;"> </span><span style="color: #89DDFF;">image</span><span style="color: #BFC7D5;">: </span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">selenium/standalone-chromium</span><span style="color: #D9F5DD;">'</span></div><div class='line'><span style="color: #BFC7D5;"> </span><span style="color: #89DDFF;">extra_hosts</span><span style="color: #BFC7D5;">:</span></div><div class='line'><span style="color: #BFC7D5;"> - </span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">host.docker.internal:host-gateway</span><span style="color: #D9F5DD;">'</span></div><div class='line'><span style="color: #BFC7D5;"> </span><span style="color: #89DDFF;">volumes</span><span style="color: #BFC7D5;">:</span></div><div class='line'><span style="color: #BFC7D5;"> - </span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">/dev/shm:/dev/shm</span><span style="color: #D9F5DD;">'</span></div><div class='line'><span style="color: #BFC7D5;"> </span><span style="color: #89DDFF;">networks</span><span style="color: #BFC7D5;">:</span></div><div class='line'><span style="color: #BFC7D5;"> - </span><span style="color: #BFC7D5;">sail</span></div></code></pre> </div> <h2 id="previewing-emails"><a href="#previewing-emails">Previewing Emails</a></h2> <p>Laravel Sail's default <code>docker-compose.yml</code> file contains a service entry for <a href="https://github.com/axllent/mailpit">Mailpit</a>. Mailpit intercepts emails sent by your application during local development and provides a convenient web interface so that you can preview your email messages in your browser. When using Sail, Mailpit's default host is <code>mailpit</code> and is available via port 1025:</p> <div class="code-container"> <pre><code data-theme="olaolu-palenight" data-lang="ini" class='torchlight' style='background-color: #292D3E; --theme-selection-background: #7580B850;'><div class='line'><span style="color: #C792EA;">MAIL_HOST</span><span style="color: #BFC7D5;">=mailpit</span></div><div class='line'><span style="color: #C792EA;">MAIL_PORT</span><span style="color: #BFC7D5;">=1025</span></div><div class='line'><span style="color: #C792EA;">MAIL_ENCRYPTION</span><span style="color: #BFC7D5;">=null</span></div></code></pre> </div> <p>When Sail is running, you may access the Mailpit web interface at: <a href="http://localhost:8025">http://localhost:8025</a></p> <h2 id="sail-container-cli"><a href="#sail-container-cli">Container CLI</a></h2> <p>Sometimes you may wish to start a Bash session within your application's container. You may use the <code>shell</code> command to connect to your application's container, allowing you to inspect its files and installed services as well as execute arbitrary shell commands within the container:</p> <div class="code-container"> <pre><code data-theme="olaolu-palenight" data-lang="shell" class='torchlight' style='background-color: #292D3E; --theme-selection-background: #7580B850;'><div class='line'><span style="color: #BFC7D5;">sail </span><span style="color: #BFC7D5;">shell</span></div><div class='line'> </div><div class='line'><span style="color: #BFC7D5;">sail </span><span style="color: #BFC7D5;">root-shell</span></div></code></pre> </div> <p>To start a new <a href="https://github.com/laravel/tinker">Laravel Tinker</a> session, you may execute the <code>tinker</code> command:</p> <div class="code-container"> <pre><code data-theme="olaolu-palenight" data-lang="shell" class='torchlight' style='background-color: #292D3E; --theme-selection-background: #7580B850;'><div class='line'><span style="color: #BFC7D5;">sail </span><span style="color: #BFC7D5;">tinker</span></div></code></pre> </div> <h2 id="sail-php-versions"><a href="#sail-php-versions">PHP Versions</a></h2> <p>Sail currently supports serving your application via PHP 8.4, 8.3, 8.2, 8.1, or PHP 8.0. The default PHP version used by Sail is currently PHP 8.4. To change the PHP version that is used to serve your application, you should update the <code>build</code> definition of the <code>laravel.test</code> container in your application's <code>docker-compose.yml</code> file:</p> <div class="code-container"> <pre><code data-theme="olaolu-palenight" data-lang="yaml" class='torchlight' style='background-color: #292D3E; --theme-selection-background: #7580B850;'><div class='line'><span style="color: #697098;">#</span><span style="color: #697098;"> PHP 8.4</span></div><div class='line'><span style="color: #89DDFF;">context</span><span style="color: #BFC7D5;">: </span><span style="color: #BFC7D5;">./vendor/laravel/sail/runtimes/8.4</span></div><div class='line'> </div><div class='line'><span style="color: #697098;">#</span><span style="color: #697098;"> PHP 8.3</span></div><div class='line'><span style="color: #89DDFF;">context</span><span style="color: #BFC7D5;">: </span><span style="color: #BFC7D5;">./vendor/laravel/sail/runtimes/8.3</span></div><div class='line'> </div><div class='line'><span style="color: #697098;">#</span><span style="color: #697098;"> PHP 8.2</span></div><div class='line'><span style="color: #89DDFF;">context</span><span style="color: #BFC7D5;">: </span><span style="color: #BFC7D5;">./vendor/laravel/sail/runtimes/8.2</span></div><div class='line'> </div><div class='line'><span style="color: #697098;">#</span><span style="color: #697098;"> PHP 8.1</span></div><div class='line'><span style="color: #89DDFF;">context</span><span style="color: #BFC7D5;">: </span><span style="color: #BFC7D5;">./vendor/laravel/sail/runtimes/8.1</span></div><div class='line'> </div><div class='line'><span style="color: #697098;">#</span><span style="color: #697098;"> PHP 8.0</span></div><div class='line'><span style="color: #89DDFF;">context</span><span style="color: #BFC7D5;">: </span><span style="color: #BFC7D5;">./vendor/laravel/sail/runtimes/8.0</span></div></code></pre> </div> <p>In addition, you may wish to update your <code>image</code> name to reflect the version of PHP being used by your application. This option is also defined in your application's <code>docker-compose.yml</code> file:</p> <div class="code-container"> <pre><code data-theme="olaolu-palenight" data-lang="yaml" class='torchlight' style='background-color: #292D3E; --theme-selection-background: #7580B850;'><div class='line'><span style="color: #89DDFF;">image</span><span style="color: #BFC7D5;">: </span><span style="color: #BFC7D5;">sail-8.2/app</span></div></code></pre> </div> <p>After updating your application's <code>docker-compose.yml</code> file, you should rebuild your container images:</p> <div class="code-container"> <pre><code data-theme="olaolu-palenight" data-lang="shell" class='torchlight' style='background-color: #292D3E; --theme-selection-background: #7580B850;'><div class='line'><span style="color: #BFC7D5;">sail </span><span style="color: #BFC7D5;">build</span><span style="color: #BFC7D5;"> </span><span style="color: #82AAFF;">--no-cache</span></div><div class='line'> </div><div class='line'><span style="color: #BFC7D5;">sail </span><span style="color: #BFC7D5;">up</span></div></code></pre> </div> <h2 id="sail-node-versions"><a href="#sail-node-versions">Node Versions</a></h2> <p>Sail installs Node 20 by default. To change the Node version that is installed when building your images, you may update the <code>build.args</code> definition of the <code>laravel.test</code> service in your application's <code>docker-compose.yml</code> file:</p> <div class="code-container"> <pre><code data-theme="olaolu-palenight" data-lang="yaml" class='torchlight' style='background-color: #292D3E; --theme-selection-background: #7580B850;'><div class='line'><span style="color: #89DDFF;">build</span><span style="color: #BFC7D5;">:</span></div><div class='line'><span style="color: #BFC7D5;"> </span><span style="color: #89DDFF;">args</span><span style="color: #BFC7D5;">:</span></div><div class='line'><span style="color: #BFC7D5;"> </span><span style="color: #89DDFF;">WWWGROUP</span><span style="color: #BFC7D5;">: </span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">${WWWGROUP}</span><span style="color: #D9F5DD;">'</span></div><div class='line'><span style="color: #BFC7D5;"> </span><span style="color: #89DDFF;">NODE_VERSION</span><span style="color: #BFC7D5;">: </span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">18</span><span style="color: #D9F5DD;">'</span></div></code></pre> </div> <p>After updating your application's <code>docker-compose.yml</code> file, you should rebuild your container images:</p> <div class="code-container"> <pre><code data-theme="olaolu-palenight" data-lang="shell" class='torchlight' style='background-color: #292D3E; --theme-selection-background: #7580B850;'><div class='line'><span style="color: #BFC7D5;">sail </span><span style="color: #BFC7D5;">build</span><span style="color: #BFC7D5;"> </span><span style="color: #82AAFF;">--no-cache</span></div><div class='line'> </div><div class='line'><span style="color: #BFC7D5;">sail </span><span style="color: #BFC7D5;">up</span></div></code></pre> </div> <h2 id="sharing-your-site"><a href="#sharing-your-site">Sharing Your Site</a></h2> <p>Sometimes you may need to share your site publicly in order to preview your site for a colleague or to test webhook integrations with your application. To share your site, you may use the <code>share</code> command. After executing this command, you will be issued a random <code>laravel-sail.site</code> URL that you may use to access your application:</p> <div class="code-container"> <pre><code data-theme="olaolu-palenight" data-lang="shell" class='torchlight' style='background-color: #292D3E; --theme-selection-background: #7580B850;'><div class='line'><span style="color: #BFC7D5;">sail </span><span style="color: #BFC7D5;">share</span></div></code></pre> </div> <p>When sharing your site via the <code>share</code> command, you should configure your application's trusted proxies using the <code>trustProxies</code> middleware method in your application's <code>bootstrap/app.php</code> file. Otherwise, URL generation helpers such as <code>url</code> and <code>route</code> will be unable to determine the correct HTTP host that should be used during URL generation:</p> <pre><code data-theme="olaolu-palenight" data-lang="php" class='torchlight' style='background-color: #292D3E; --theme-selection-background: #7580B850;'><div class='line'><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">withMiddleware</span><span style="color: #BFC7D5;">(</span><span style="color: #C792EA;">function</span><span style="color: #BFC7D5;"> </span><span style="color: #D9F5DD;">(</span><span style="color: #FFCB8B;">Middleware</span><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$middleware</span><span style="color: #D9F5DD;">)</span><span style="color: #BFC7D5;"> {</span></div><div class='line'><span style="color: #BFC7D5;"> </span><span style="color: #BEC5D4;">$middleware</span><span style="color: #89DDFF;">-></span><span style="color: #82AAFF;">trustProxies</span><span style="color: #BFC7D5;">(at: </span><span style="color: #D9F5DD;">'</span><span style="color: #C3E88D;">*</span><span style="color: #D9F5DD;">'</span><span style="color: #BFC7D5;">);</span></div><div class='line'><span style="color: #BFC7D5;">})</span></div></code></pre> <p>If you would like to choose the subdomain for your shared site, you may provide the <code>subdomain</code> option when executing the <code>share</code> command:</p> <div class="code-container"> <pre><code data-theme="olaolu-palenight" data-lang="shell" class='torchlight' style='background-color: #292D3E; --theme-selection-background: #7580B850;'><div class='line'><span style="color: #BFC7D5;">sail </span><span style="color: #BFC7D5;">share</span><span style="color: #BFC7D5;"> </span><span style="color: #82AAFF;">--subdomain=my-sail-site</span></div></code></pre> </div> <div class="mb-10 max-w-2xl mx-auto px-4 py-8 shadow-lg lg:flex lg:items-center callout"> <div class="w-20 h-20 mb-6 flex items-center justify-center shrink-0 lg:mb-0 bg-purple-600"> <div class="opacity-75"><svg width="28" height="40" viewBox="0 0 28 40" xmlns="http://www.w3.org/2000/svg"><title>lightbulb</title><path d="M12 28h4v-8h-4v8zM8 40h12v-8H8v8zm13.98-14.52c-1.001.705-1.661 1.545-1.98 2.52H8c-.416-.959-1.076-1.799-1.98-2.52A13.99 13.99 0 0 1 0 14C0 6.272 6.272 0 14 0s14 6.272 14 14a13.99 13.99 0 0 1-6.02 11.48z" fill="#FFF" fill-rule="nonzero"/></svg></div> </div> <p class="mb-0 lg:ml-6 callout"> The <code>share</code> command is powered by <a href="https://github.com/beyondcode/expose">Expose</a>, an open source tunneling service by <a href="https://beyondco.de">BeyondCode</a>.</p> </div> <h2 id="debugging-with-xdebug"><a href="#debugging-with-xdebug">Debugging With Xdebug</a></h2> <p>Laravel Sail's Docker configuration includes support for <a href="https://xdebug.org/">Xdebug</a>, a popular and powerful debugger for PHP. To enable Xdebug, ensure you have <a href="#sail-customization">published your Sail configuration</a>. Then, add the following variables to your application's <code>.env</code> file to configure Xdebug:</p> <div class="code-container"> <pre><code data-theme="olaolu-palenight" data-lang="ini" class='torchlight' style='background-color: #292D3E; --theme-selection-background: #7580B850;'><div class='line'><span style="color: #C792EA;">SAIL_XDEBUG_MODE</span><span style="color: #BFC7D5;">=develop,debug,coverage</span></div></code></pre> </div> <p>Next, ensure that your published <code>php.ini</code> file includes the following configuration so that Xdebug is activated in the specified modes:</p> <div class="code-container"> <pre><code data-theme="olaolu-palenight" data-lang="ini" class='torchlight' style='background-color: #292D3E; --theme-selection-background: #7580B850;'><div class='line'><span style="color: #BFC7D5;">[xdebug]</span></div><div class='line'><span style="color: #C792EA;">xdebug.mode</span><span style="color: #BFC7D5;">=${XDEBUG_MODE}</span></div></code></pre> </div> <p>After modifying the <code>php.ini</code> file, remember to rebuild your Docker images so that your changes to the <code>php.ini</code> file take effect:</p> <div class="code-container"> <pre><code data-theme="olaolu-palenight" data-lang="shell" class='torchlight' style='background-color: #292D3E; --theme-selection-background: #7580B850;'><div class='line'><span style="color: #BFC7D5;">sail </span><span style="color: #BFC7D5;">build</span><span style="color: #BFC7D5;"> </span><span style="color: #82AAFF;">--no-cache</span></div></code></pre> </div> <h4>Linux Host IP Configuration</h4> <p>Internally, the <code>XDEBUG_CONFIG</code> environment variable is defined as <code>client_host=host.docker.internal</code> so that Xdebug will be properly configured for Mac and Windows (WSL2). If your local machine is running Linux and you're using Docker 20.10+, <code>host.docker.internal</code> is available, and no manual configuration is required.</p> <p>For Docker versions older than 20.10, <code>host.docker.internal</code> is not supported on Linux, and you will need to manually define the host IP. To do this, configure a static IP for your container by defining a custom network in your <code>docker-compose.yml</code> file:</p> <div class="code-container"> <pre><code data-theme="olaolu-palenight" data-lang="yaml" class='torchlight' style='background-color: #292D3E; --theme-selection-background: #7580B850;'><div class='line'><span style="color: #89DDFF;">networks</span><span style="color: #BFC7D5;">:</span></div><div class='line'><span style="color: #BFC7D5;"> </span><span style="color: #89DDFF;">custom_network</span><span style="color: #BFC7D5;">:</span></div><div class='line'><span style="color: #BFC7D5;"> </span><span style="color: #89DDFF;">ipam</span><span style="color: #BFC7D5;">:</span></div><div class='line'><span style="color: #BFC7D5;"> </span><span style="color: #89DDFF;">config</span><span style="color: #BFC7D5;">:</span></div><div class='line'><span style="color: #BFC7D5;"> - </span><span style="color: #89DDFF;">subnet</span><span style="color: #BFC7D5;">: </span><span style="color: #BFC7D5;">172.20.0.0/16</span></div><div class='line'> </div><div class='line'><span style="color: #89DDFF;">services</span><span style="color: #BFC7D5;">:</span></div><div class='line'><span style="color: #BFC7D5;"> </span><span style="color: #89DDFF;">laravel.test</span><span style="color: #BFC7D5;">:</span></div><div class='line'><span style="color: #BFC7D5;"> </span><span style="color: #89DDFF;">networks</span><span style="color: #BFC7D5;">:</span></div><div class='line'><span style="color: #BFC7D5;"> </span><span style="color: #89DDFF;">custom_network</span><span style="color: #BFC7D5;">:</span></div><div class='line'><span style="color: #BFC7D5;"> </span><span style="color: #89DDFF;">ipv4_address</span><span style="color: #BFC7D5;">: </span><span style="color: #F78C6C;">172.20.0.2</span></div></code></pre> </div> <p>Once you have set the static IP, define the SAIL_XDEBUG_CONFIG variable within your application's .env file:</p> <div class="code-container"> <pre><code data-theme="olaolu-palenight" data-lang="ini" class='torchlight' style='background-color: #292D3E; --theme-selection-background: #7580B850;'><div class='line'><span style="color: #C792EA;">SAIL_XDEBUG_CONFIG</span><span style="color: #BFC7D5;">=</span><span style="color: #D9F5DD;">"</span><span style="color: #C3E88D;">client_host=172.20.0.2</span><span style="color: #D9F5DD;">"</span></div></code></pre> </div> <h3 id="xdebug-cli-usage"><a href="#xdebug-cli-usage">Xdebug CLI Usage</a></h3> <p>A <code>sail debug</code> command may be used to start a debugging session when running an Artisan command:</p> <div class="code-container"> <pre><code data-theme="olaolu-palenight" data-lang="shell" class='torchlight' style='background-color: #292D3E; --theme-selection-background: #7580B850;'><div class='line'><span style="color: #697098;">#</span><span style="color: #697098;"> Run an Artisan command without Xdebug...</span></div><div class='line'><span style="color: #BFC7D5;">sail </span><span style="color: #BFC7D5;">artisan</span><span style="color: #BFC7D5;"> </span><span style="color: #BFC7D5;">migrate</span></div><div class='line'> </div><div class='line'><span style="color: #697098;">#</span><span style="color: #697098;"> Run an Artisan command with Xdebug...</span></div><div class='line'><span style="color: #BFC7D5;">sail </span><span style="color: #BFC7D5;">debug</span><span style="color: #BFC7D5;"> </span><span style="color: #BFC7D5;">migrate</span></div></code></pre> </div> <h3 id="xdebug-browser-usage"><a href="#xdebug-browser-usage">Xdebug Browser Usage</a></h3> <p>To debug your application while interacting with the application via a web browser, follow the <a href="https://xdebug.org/docs/step_debug#web-application">instructions provided by Xdebug</a> for initiating an Xdebug session from the web browser.</p> <p>If you're using PhpStorm, please review JetBrains' documentation regarding <a href="https://www.jetbrains.com/help/phpstorm/zero-configuration-debugging.html">zero-configuration debugging</a>.</p> <div class="mb-10 max-w-2xl mx-auto px-4 py-8 shadow-lg lg:flex lg:items-center callout"> <div class="w-20 h-20 mb-6 flex items-center justify-center shrink-0 lg:mb-0 bg-red-600"> <div class="opacity-75"><svg width="6" height="35" viewBox="0 0 6 35" xmlns="http://www.w3.org/2000/svg"><title>exclamation</title><path d="M0 29h6v6H0v-6zM0 0h6v24H0V0z" fill="#FFF" fill-rule="nonzero"/></svg> </div> </div> <p class="mb-0 lg:ml-6 callout"> Laravel Sail relies on <code>artisan serve</code> to serve your application. The <code>artisan serve</code> command only accepts the <code>XDEBUG_CONFIG</code> and <code>XDEBUG_MODE</code> variables as of Laravel version 8.53.0. Older versions of Laravel (8.52.0 and below) do not support these variables and will not accept debug connections.</p> </div> <h2 id="sail-customization"><a href="#sail-customization">Customization</a></h2> <p>Since Sail is just Docker, you are free to customize nearly everything about it. To publish Sail's own Dockerfiles, you may execute the <code>sail:publish</code> command:</p> <div class="code-container"> <pre><code data-theme="olaolu-palenight" data-lang="shell" class='torchlight' style='background-color: #292D3E; --theme-selection-background: #7580B850;'><div class='line'><span style="color: #BFC7D5;">sail </span><span style="color: #BFC7D5;">artisan</span><span style="color: #BFC7D5;"> </span><span style="color: #BFC7D5;">sail:publish</span></div></code></pre> </div> <p>After running this command, the Dockerfiles and other configuration files used by Laravel Sail will be placed within a <code>docker</code> directory in your application's root directory. After customizing your Sail installation, you may wish to change the image name for the application container in your application's <code>docker-compose.yml</code> file. After doing so, rebuild your application's containers using the <code>build</code> command. Assigning a unique name to the application image is particularly important if you are using Sail to develop multiple Laravel applications on a single machine:</p> <div class="code-container"> <pre><code data-theme="olaolu-palenight" data-lang="shell" class='torchlight' style='background-color: #292D3E; --theme-selection-background: #7580B850;'><div class='line'><span style="color: #BFC7D5;">sail </span><span style="color: #BFC7D5;">build</span><span style="color: #BFC7D5;"> </span><span style="color: #82AAFF;">--no-cache</span></div></code></pre> </div> <script async type="text/javascript" src="//cdn.carbonads.com/carbon.js?serve=CKYILK3E&placement=laravelcom" id="_carbonads_js"></script> </div> </section> </section> </div> </section> </div> </div> <footer class="relative pt-12 dark:bg-dark-700"> <div class="max-w-screen-2xl mx-auto w-full px-8"> <div> <a href="/" class="inline-flex"> <img class="w-16 h-16" src="/img/logomark.min.svg" alt="Laravel" width="64" height="64" loading="lazy"> </a> </div> <div class="mt-6 grid grid-cols-12 md:gap-x-8 gap-y-12 sm:mt-12"> <div class="col-span-12 lg:col-span-4"> <p class="max-w-sm text-xs text-gray-700 sm:text-sm dark:text-gray-500"> Laravel is a web application framework with expressive, elegant syntax. We believe development must be an enjoyable and creative experience to be truly fulfilling. Laravel attempts to take the pain out of development by easing common tasks used in most web projects.</p> <ul class="mt-6 flex items-center space-x-3"> <li> <a href="https://x.com/laravelphp"> <img class="hidden dark:inline-block w-6 h-6" src="/img/social/x.dark.min.svg" alt="X" width="24" height="20" loading="lazy"> <img class="inline-block dark:hidden w-6 h-6" src="/img/social/x.min.svg" alt="X" width="24" height="20" loading="lazy"> </a> </li> <li> <a href="https://github.com/laravel"> <img class="hidden dark:inline-block w-6 h-6" src="/img/social/github.dark.min.svg" alt="GitHub" width="24" height="24" loading="lazy"> <img class="inline-block dark:hidden w-6 h-6" src="/img/social/github.min.svg" alt="GitHub" width="24" height="24" loading="lazy"> </a> </li> <li> <a href="https://discord.gg/laravel"> <img class="hidden dark:inline-block w-6 h-6" src="/img/social/discord.dark.min.svg" alt="Discord" width="21" height="24" loading="lazy"> <img class="inline-block dark:hidden w-6 h-6" src="/img/social/discord.min.svg" alt="Discord" width="21" height="24" loading="lazy"> </a> </li> <li> <a href="https://www.youtube.com/laravelphp"> <img class="hidden dark:inline-block w-6 h-6" src="/img/social/youtube.dark.min.svg" alt="YouTube" width="169" height="150" loading="lazy"> <img class="inline-block dark:hidden w-6 h-6" src="/img/social/youtube.min.svg" alt="YouTube" width="169" height="150" loading="lazy"> </a> </li> </ul> </div> <div class="text-xs col-span-6 md:col-span-3 lg:col-span-2"> <span class="uppercase dark:text-gray-200">Highlights</span> <div class="mt-5"> <ul class="space-y-3 text-gray-700 dark:text-gray-500"> <li> <a href="/docs/11.x/releases" class="transition-colors hover:text-gray-600 dark:hover:text-gray-400">Release Notes</a> </li> <li> <a href="/docs/11.x/installation" class="transition-colors hover:text-gray-600 dark:hover:text-gray-400">Getting Started</a> </li> <li> <a href="/docs/11.x/routing" class="transition-colors hover:text-gray-600 dark:hover:text-gray-400">Routing</a> </li> <li> <a href="/docs/11.x/blade" class="transition-colors hover:text-gray-600 dark:hover:text-gray-400">Blade Templates</a> </li> <li> <a href="/docs/11.x/authentication" class="transition-colors hover:text-gray-600 dark:hover:text-gray-400">Authentication</a> </li> <li> <a href="/docs/11.x/authorization" class="transition-colors hover:text-gray-600 dark:hover:text-gray-400">Authorization</a> </li> <li> <a href="/docs/11.x/artisan" class="transition-colors hover:text-gray-600 dark:hover:text-gray-400">Artisan Console</a> </li> <li> <a href="/docs/11.x/database" class="transition-colors hover:text-gray-600 dark:hover:text-gray-400">Database</a> </li> <li> <a href="/docs/11.x/eloquent" class="transition-colors hover:text-gray-600 dark:hover:text-gray-400">Eloquent ORM</a> </li> <li> <a href="/docs/11.x/testing" class="transition-colors hover:text-gray-600 dark:hover:text-gray-400">Testing</a> </li> </ul> </div> </div> <div class="text-xs col-span-6 md:col-span-3 lg:col-span-2"> <span class="uppercase dark:text-gray-200">Resources</span> <div class="mt-5"> <ul class="space-y-3 text-gray-700 dark:text-gray-500"> <li> <a href="https://bootcamp.laravel.com" class="transition-colors hover:text-gray-600 dark:hover:text-gray-400">Laravel Bootcamp</a> </li> <li> <a href="https://laracasts.com" class="transition-colors hover:text-gray-600 dark:hover:text-gray-400">Laracasts</a> </li> <li> <a href="https://laravel-news.com" class="transition-colors hover:text-gray-600 dark:hover:text-gray-400">Laravel News</a> </li> <li> <a href="https://laracon.us" class="transition-colors hover:text-gray-600 dark:hover:text-gray-400">Laracon</a> </li> <li> <a href="https://laracon.au" class="transition-colors hover:text-gray-600 dark:hover:text-gray-400">Laracon AU</a> </li> <li> <a href="https://laracon.eu/" class="transition-colors hover:text-gray-600 dark:hover:text-gray-400">Laracon EU</a> </li> <li> <a href="https://laracon.in/" class="transition-colors hover:text-gray-600 dark:hover:text-gray-400">Laracon India</a> </li> <li> <a href="https://larabelles.com/" class="transition-colors hover:text-gray-600 dark:hover:text-gray-400">Larabelles</a> </li> <li> <a href="https://laravel.com/careers" class="transition-colors hover:text-gray-600 dark:hover:text-gray-400">Careers</a> </li> <li> <a href="https://larajobs.com/?partner=5" class="transition-colors hover:text-gray-600 dark:hover:text-gray-400">Jobs</a> </li> <li> <a href="https://laracasts.com/discuss" class="transition-colors hover:text-gray-600 dark:hover:text-gray-400">Forums</a> </li> <li> <a href="/trademark" class="transition-colors hover:text-gray-600 dark:hover:text-gray-400">Trademark</a> </li> </ul> </div> </div> <div class="text-xs col-span-6 md:col-span-3 lg:col-span-2"> <span class="uppercase dark:text-gray-200">Partners</span> <div class="mt-5"> <ul class="space-y-3 text-gray-700 dark:text-gray-500"> <li> <a href="https://vehikl.com" class="transition-colors hover:text-gray-600 dark:hover:text-gray-400">Vehikl</a> </li> <li> <a href="https://webreinvent.com/?utm_source=laravel&utm_medium=laravel.com&utm_campaign=footer-link" class="transition-colors hover:text-gray-600 dark:hover:text-gray-400">WebReinvent</a> </li> <li> <a href="https://tighten.co" class="transition-colors hover:text-gray-600 dark:hover:text-gray-400">Tighten</a> </li> <li> <a href="https://www.bacancytechnology.com/hire-laravel-developer?utm_source=laravel&utm_medium=partners.laravel&utm_campaign=sponsors" class="transition-colors hover:text-gray-600 dark:hover:text-gray-400">Bacancy</a> </li> <li> <a href="https://64robots.com/" class="transition-colors hover:text-gray-600 dark:hover:text-gray-400">64 Robots</a> </li> <li> <a href="https://activelogic.com/" class="transition-colors hover:text-gray-600 dark:hover:text-gray-400">Active Logic</a> </li> <li> <a href="https://adevait.com/laravel" class="transition-colors hover:text-gray-600 dark:hover:text-gray-400">Adeva</a> </li> <li> <a href="https://www.blackairplane.com/" class="transition-colors hover:text-gray-600 dark:hover:text-gray-400">Black Airplane</a> </li> <li> <a href="https://www.byte5.net/" class="transition-colors hover:text-gray-600 dark:hover:text-gray-400">Byte 5</a> </li> <li> <a href="https://www.curotec.com/services/technologies/laravel/" class="transition-colors hover:text-gray-600 dark:hover:text-gray-400">Curotec</a> </li> <li> <a href="https://www.cyber-duck.co.uk/how-we-work/technology/laravel?utm_source=Laravel%20Partner&utm_medium=Sponsorship" class="transition-colors hover:text-gray-600 dark:hover:text-gray-400">Cyber-Duck</a> </li> <li> <a href="https://devsquad.com/" class="transition-colors hover:text-gray-600 dark:hover:text-gray-400">DevSquad</a> </li> <li> <a href="https://jump24.co.uk/" class="transition-colors hover:text-gray-600 dark:hover:text-gray-400">Jump24</a> </li> <li> <a href="https://kirschbaumdevelopment.com/" class="transition-colors hover:text-gray-600 dark:hover:text-gray-400">Kirschbaum</a> </li> </ul> </div> </div> <div class="text-xs col-span-6 md:col-span-3 lg:col-span-2"> <span class="uppercase dark:text-gray-200">Ecosystem</span> <div class="mt-5"> <ul class="space-y-3 text-gray-700 dark:text-gray-500"> <li> <a href="/docs/11.x/starter-kits#laravel-breeze" class="transition-colors hover:text-gray-600 dark:hover:text-gray-400">Breeze</a> </li> <li> <a href="/docs/11.x/billing" class="transition-colors hover:text-gray-600 dark:hover:text-gray-400">Cashier</a> </li> <li> <a href="/docs/11.x/dusk" class="transition-colors hover:text-gray-600 dark:hover:text-gray-400">Dusk</a> </li> <li> <a href="/docs/11.x/broadcasting" class="transition-colors hover:text-gray-600 dark:hover:text-gray-400">Echo</a> </li> <li> <a href="https://envoyer.io" class="transition-colors hover:text-gray-600 dark:hover:text-gray-400">Envoyer</a> </li> <li> <a href="https://forge.laravel.com" class="transition-colors hover:text-gray-600 dark:hover:text-gray-400">Forge</a> </li> <li> <a href="https://herd.laravel.com" class="transition-colors hover:text-gray-600 dark:hover:text-gray-400">Herd</a> </li> <li> <a href="/docs/11.x/horizon" class="transition-colors hover:text-gray-600 dark:hover:text-gray-400">Horizon</a> </li> <li> <a href="https://inertiajs.com" class="transition-colors hover:text-gray-600 dark:hover:text-gray-400">Inertia</a> </li> <li> <a href="https://jetstream.laravel.com" class="transition-colors hover:text-gray-600 dark:hover:text-gray-400">Jetstream</a> </li> <li> <a href="https://livewire.laravel.com" class="transition-colors hover:text-gray-600 dark:hover:text-gray-400">Livewire</a> </li> <li> <a href="https://nova.laravel.com" class="transition-colors hover:text-gray-600 dark:hover:text-gray-400">Nova</a> </li> <li> <a href="/docs/11.x/octane" class="transition-colors hover:text-gray-600 dark:hover:text-gray-400">Octane</a> </li> <li> <a href="/docs/11.x/pennant" class="transition-colors hover:text-gray-600 dark:hover:text-gray-400">Pennant</a> </li> <li> <a href="/docs/11.x/pint" class="transition-colors hover:text-gray-600 dark:hover:text-gray-400">Pint</a> </li> <li> <a href="/docs/11.x/prompts" class="transition-colors hover:text-gray-600 dark:hover:text-gray-400">Prompts</a> </li> <li> <a href="https://pulse.laravel.com" class="transition-colors hover:text-gray-600 dark:hover:text-gray-400">Pulse</a> </li> <li> <a href="https://reverb.laravel.com" class="transition-colors hover:text-gray-600 dark:hover:text-gray-400">Reverb</a> </li> <li> <a href="/docs/11.x/sail" class="transition-colors hover:text-gray-600 dark:hover:text-gray-400">Sail</a> </li> <li> <a href="/docs/11.x/sanctum" class="transition-colors hover:text-gray-600 dark:hover:text-gray-400">Sanctum</a> </li> <li> <a href="/docs/11.x/scout" class="transition-colors hover:text-gray-600 dark:hover:text-gray-400">Scout</a> </li> <li> <a href="/docs/11.x/socialite" class="transition-colors hover:text-gray-600 dark:hover:text-gray-400">Socialite</a> </li> <li> <a href="https://spark.laravel.com" class="transition-colors hover:text-gray-600 dark:hover:text-gray-400">Spark</a> </li> <li> <a href="/docs/11.x/telescope" class="transition-colors hover:text-gray-600 dark:hover:text-gray-400">Telescope</a> </li> <li> <a href="https://vapor.laravel.com" class="transition-colors hover:text-gray-600 dark:hover:text-gray-400">Vapor</a> </li> </ul> </div> </div> </div> <div class="mt-10 border-t pt-6 pb-16 border-gray-200 dark:border-dark-500"> <p class="text-xs text-gray-700 dark:text-gray-400"> Laravel is a Trademark of Laravel Holdings Inc.<br /> Copyright © 2011-2025 Laravel Holdings Inc. </p> <p class="mt-6 text-xs text-gray-700 dark:text-gray-400"> Code highlighting provided by <a href="https://torchlight.dev">Torchlight</a> </p> </div> </div> </footer> <script> var algolia_app_id = 'E3MIRNPJH5'; var algolia_search_key = '1fa3a8fec06eb1858d6ca137211225c0'; var version = '11.x'; </script> <script> var _gaq=[['_setAccount','UA-23865777-1'],['_trackPageview']]; (function(d,t){ var g=d.createElement(t),s=d.getElementsByTagName(t)[0]; g.src=('https:'==location.protocol?'//ssl':'//www')+'.google-analytics.com/ga.js'; s.parentNode.insertBefore(g,s) }(document,'script')); </script>  <script type="text/javascript" id="hs-script-loader" async defer src="//js-na1.hs-scripts.com/45240648.js"></script> <div class="fixed"> <input type="text"> </div> </body> </html>

CINXE.COM

Laravel Sail - Laravel 11.x - The PHP Framework For Web Artisans