CINXE.COM

<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1"> <title>Laravel Sail - Laravel 11.x - The PHP Framework For Web Artisans</title> <link rel="canonical" href="https://laravel.com/docs/12.x/sail">  <meta name="title" content="Laravel Sail - Laravel 11.x - 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 Sail - Laravel 11.x - 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/images/og/laravel-docs.png">  <meta property="twitter:card" content="summary_large_image"> <meta property="twitter:url" content="https://laravel.com/"> <meta property="twitter:title" content="Laravel Sail - Laravel 11.x - 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/images/og/laravel-docs.png">  <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="preload" href="/fonts/InstrumentSans.woff2" as="font" type="font/woff2" crossorigin="anonymous" /> <link rel="preconnect" href="https://E3MIRNPJH5-dsn.algolia.net" crossorigin /> <link rel="preload" as="style" href="https://laravel.com/build/assets/app-DTuzKHzc.css" /><link rel="modulepreload" href="https://laravel.com/build/assets/app-DsFpo0m6.js" /><link rel="modulepreload" href="https://laravel.com/build/assets/mediaQuery-Bm25Hv93.js" /><link rel="modulepreload" href="https://laravel.com/build/assets/module.esm-BKQTc33J.js" /><link rel="modulepreload" href="https://laravel.com/build/assets/docs-Ch76ti3c.js" /><link rel="modulepreload" href="https://laravel.com/build/assets/theme-switcher-CvREX8Sp.js" /><link rel="stylesheet" href="https://laravel.com/build/assets/app-DTuzKHzc.css" /><script type="module" src="https://laravel.com/build/assets/app-DsFpo0m6.js"></script><script type="module" src="https://laravel.com/build/assets/docs-Ch76ti3c.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; const algolia_app_id = 'E3MIRNPJH5'; const algolia_search_key = '1fa3a8fec06eb1858d6ca137211225c0'; const version = '11.x'; if (!alwaysLightMode) { if (localStorage.theme === 'dark' || (localStorage.theme === 'system' && window.matchMedia("(prefers-color-scheme: dark)").matches)) { document.documentElement.classList.add("dark"); document.documentElement.setAttribute("data-theme", "dark"); document.documentElement.setAttribute("color-theme", "dark"); } } </script> <script> document.addEventListener('DOMContentLoaded', function () { // Set a CSS variable for the viewport width for the divider component document.documentElement.style.setProperty('--viewport-width', (document.body.clientWidth || 0)+'px'); }); window.addEventListener('resize', function () { document.documentElement.style.setProperty('--viewport-width', (document.body.clientWidth || 0)+'px'); }, { passive: true }); </script> </head> <body class="font-sans antialiased text-sand-light-12 bg-sand-light-1 dark:bg-sand-dark-1"> <div class="xl:px-0 mx-auto xl:max-w-[1400px] w-full max-w-full"> <div class="relative xl:border-l xl:mx-auto bg-sand-light-1 dark:bg-sand-dark-1 xl:border-sand-light-7 xl:dark:border-sand-dark-6"> <div id="nav-trigger" class="absolute left-0 top-32"></div> <nav class="sticky top-0 z-99 px-4 xl:px-16 py-8 h-(--popover-top-offset) dark:bg-sand-dark-1 transition-transform duration-300 bg-sand-light-1 border-b border-transparent sticky-nav docs-nav"> <div class="grid grid-cols-12 gap-4 lg:gap-6 xl:gap-x-10 relative items-center h-full overflow-hidden"> <ul class="flex items-start col-span-3 space-x-8 font-medium "> <li class="w-20 transition-transform duration-300 ease-in-out mr-18 text-laravel-red" id="nav-left"> <a href="https://laravel.com" class="flex items-center w-20 aspect-[80/23]"> <svg class="w-full h-full" width="1280" height="308" viewBox="0 0 1280 308" fill="none" xmlns="http://www.w3.org/2000/svg" > <path d="M50.2753 0H0V308.689H144.713V263.27H50.2753V0Z" fill="currentColor" /> <path d="M322.209 130.973C315.796 120.684 306.688 112.602 294.883 106.718C283.081 100.84 271.201 97.8969 259.253 97.8969C243.798 97.8969 229.665 100.764 216.843 106.496C204.014 112.228 193.015 120.099 183.834 130.091C174.654 140.088 167.51 151.628 162.412 164.706C157.308 177.792 154.761 191.54 154.761 205.94C154.761 220.645 157.308 234.457 162.412 247.39C167.508 260.332 174.652 271.796 183.834 281.788C193.015 291.785 204.017 299.647 216.843 305.379C229.665 311.111 243.798 313.978 259.253 313.978C271.201 313.978 283.081 311.038 294.883 305.159C306.688 299.282 315.796 291.197 322.209 280.904V308.685H369.865V103.186H322.209V130.973ZM317.837 231.076C314.922 239.016 310.841 245.925 305.598 251.804C300.35 257.687 294.009 262.389 286.579 265.917C279.146 269.445 270.905 271.208 261.875 271.208C252.837 271.208 244.676 269.445 237.391 265.917C230.104 262.389 223.839 257.687 218.593 251.804C213.345 245.925 209.335 239.016 206.57 231.076C203.794 223.138 202.417 214.759 202.417 205.942C202.417 197.12 203.794 188.742 206.57 180.804C209.335 172.866 213.345 165.961 218.593 160.078C223.839 154.201 230.102 149.493 237.391 145.965C244.676 142.437 252.837 140.674 261.875 140.674C270.908 140.674 279.146 142.437 286.579 145.965C294.009 149.493 300.35 154.199 305.598 160.078C310.844 165.961 314.922 172.866 317.837 180.804C320.748 188.742 322.209 197.12 322.209 205.942C322.209 214.759 320.748 223.138 317.837 231.076Z" fill="currentColor" /> <path d="M709.568 130.973C703.155 120.684 694.047 112.602 682.242 106.718C670.44 100.84 658.56 97.8969 646.612 97.8969C631.157 97.8969 617.024 100.764 604.202 106.496C591.373 112.228 580.374 120.099 571.193 130.091C562.013 140.088 554.869 151.628 549.771 164.706C544.666 177.792 542.12 191.54 542.12 205.94C542.12 220.645 544.666 234.457 549.771 247.39C554.867 260.332 562.01 271.796 571.193 281.788C580.374 291.785 591.375 299.647 604.202 305.379C617.024 311.111 631.157 313.978 646.612 313.978C658.56 313.978 670.44 311.038 682.242 305.159C694.047 299.282 703.155 291.197 709.568 280.904V308.685H757.224V103.186H709.568V130.973ZM705.198 231.076C702.283 239.016 698.202 245.925 692.959 251.804C687.711 257.687 681.37 262.389 673.94 265.917C666.507 269.445 658.266 271.208 649.236 271.208C640.198 271.208 632.037 269.445 624.752 265.917C617.465 262.389 611.2 257.687 605.954 251.804C600.706 245.925 596.696 239.016 593.931 231.076C591.155 223.138 589.778 214.759 589.778 205.942C589.778 197.12 591.155 188.742 593.931 180.804C596.696 172.866 600.706 165.961 605.954 160.078C611.2 154.201 617.463 149.493 624.752 145.965C632.037 142.437 640.198 140.674 649.236 140.674C658.269 140.674 666.507 142.437 673.94 145.965C681.37 149.493 687.711 154.199 692.959 160.078C698.205 165.961 702.283 172.866 705.198 180.804C708.109 188.742 709.57 197.12 709.57 205.942C709.568 214.759 708.107 223.138 705.198 231.076Z" fill="currentColor" /> <path d="M1280 1.12315e-05H1232.35V308.689H1280V1.12315e-05Z" fill="currentColor" /> <path d="M407.466 308.689H455.117V150.486H536.876V103.192H407.466V308.689Z" fill="currentColor" /> <path d="M948.281 103.192L888.386 260.557L828.489 103.192H780.224L858.441 308.689H918.331L996.546 103.192H948.281Z" fill="currentColor" /> <path d="M1100.48 97.908C1042.13 97.908 995.937 146.279 995.937 205.944C995.937 271.9 1040.64 313.98 1106.59 313.98C1143.5 313.98 1167.06 299.745 1195.85 268.746L1163.66 243.621C1163.64 243.646 1139.36 275.802 1103.1 275.802C1060.96 275.802 1043.22 241.533 1043.22 223.803H1201.32C1209.62 155.913 1165.37 97.908 1100.48 97.908ZM1043.35 188.085C1043.71 184.13 1049.2 136.086 1100.1 136.086C1151.01 136.086 1157.19 184.123 1157.55 188.085H1043.35Z" fill="currentColor" /> </svg> <span class="sr-only">Home</span> </a> </li> </ul> <div class="absolute top-0 flex items-center p-2 cursor-pointer right-9 lg:right-auto lg:top-auto lg:relative lg:col-span-6 lg:w-full lg:hover:bg-sand-light-4 lg:dark:hover:bg-sand-dark-4 rounded-xs lg:dark:bg-sand-dark-5 lg:bg-sand-light-3 text-sand-light-9-alpha-45 dark:text-sand-dark-11"> <svg class="w-6 h-6 lg:w-5 lg:h-5 lg:mr-2 shrink-0" width="20" height="20" viewBox="0 0 20 20" fill="none" xmlns="http://www.w3.org/2000/svg" > <g> <path d="M15.8333 15.8333L13.0523 13.0524M13.0523 13.0524C13.9943 12.1104 14.5769 10.8092 14.5769 9.3718C14.5769 6.49708 12.2465 4.16667 9.37176 4.16667C6.49704 4.16667 4.16663 6.49708 4.16663 9.3718C4.16663 12.2465 6.49704 14.5769 9.37176 14.5769C10.8091 14.5769 12.1104 13.9943 13.0523 13.0524Z" stroke="currentColor" stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" /> </g> </svg> <div class="grow"> <div id="docsearch" class="absolute inset-0 lg:*:px-9 lg:*:py-1.5 *:absolute *:inset-0 text-base bg-transparent text-sand-light-9-alpha-45/70 dark:text-sand-dark-10"></div> </div> <span class="ml-2 hidden lg:block mr-1.5 text-sm font-medium shrink-0 text-sand-light-9 dark:text-sand-dark-10">⌘K</span> </div> <div class="flex items-center justify-end col-span-9 gap-4 lg:col-span-3 dark:text-sand-dark-12"> <select x-data aria-label="Laravel version" @change="window.location = $event.target.value" class="hidden text-sm py-1.5 px-3 bg-sand-light-1 dark:bg-sand-dark-1 border-0 whitespace-nowrap lg:block" > <option value="https://laravel.com/docs/master/sail"> Version Master </option> <option value="https://laravel.com/docs/12.x/sail"> Version 12.x </option> <option selected value="https://laravel.com/docs/11.x/sail"> Version 11.x </option> <option value="https://laravel.com/docs/10.x/sail"> Version 10.x </option> <option value="https://laravel.com/docs/9.x/sail"> Version 9.x </option> <option value="https://laravel.com/docs/8.x/sail"> Version 8.x </option> <option value="https://laravel.com/docs/7.x/sail"> Version 7.x </option> <option value="https://laravel.com/docs/6.x/sail"> Version 6.x </option> <option value="https://laravel.com/docs/5.8/sail"> Version 5.8 </option> <option value="https://laravel.com/docs/5.7/sail"> Version 5.7 </option> <option value="https://laravel.com/docs/5.6/sail"> Version 5.6 </option> <option value="https://laravel.com/docs/5.5/sail"> Version 5.5 </option> <option value="https://laravel.com/docs/5.4/sail"> Version 5.4 </option> <option value="https://laravel.com/docs/5.3/sail"> Version 5.3 </option> <option value="https://laravel.com/docs/5.2/sail"> Version 5.2 </option> <option value="https://laravel.com/docs/5.1/sail"> Version 5.1 </option> <option value="https://laravel.com/docs/5.0/sail"> Version 5.0 </option> <option value="https://laravel.com/docs/4.2/sail"> Version 4.2 </option> </select> <select x-data aria-label="Laravel version" @change="window.location = $event.target.value" class="text-sm py-1.5 px-3 bg-sand-light-1 dark:bg-sand-dark-1 border-0 whitespace-nowrap lg:hidden" > <option value="https://laravel.com/docs/master/sail"> vMaster </option> <option value="https://laravel.com/docs/12.x/sail"> v12.x </option> <option selected value="https://laravel.com/docs/11.x/sail"> v11.x </option> <option value="https://laravel.com/docs/10.x/sail"> v10.x </option> <option value="https://laravel.com/docs/9.x/sail"> v9.x </option> <option value="https://laravel.com/docs/8.x/sail"> v8.x </option> <option value="https://laravel.com/docs/7.x/sail"> v7.x </option> <option value="https://laravel.com/docs/6.x/sail"> v6.x </option> <option value="https://laravel.com/docs/5.8/sail"> v5.8 </option> <option value="https://laravel.com/docs/5.7/sail"> v5.7 </option> <option value="https://laravel.com/docs/5.6/sail"> v5.6 </option> <option value="https://laravel.com/docs/5.5/sail"> v5.5 </option> <option value="https://laravel.com/docs/5.4/sail"> v5.4 </option> <option value="https://laravel.com/docs/5.3/sail"> v5.3 </option> <option value="https://laravel.com/docs/5.2/sail"> v5.2 </option> <option value="https://laravel.com/docs/5.1/sail"> v5.1 </option> <option value="https://laravel.com/docs/5.0/sail"> v5.0 </option> <option value="https://laravel.com/docs/4.2/sail"> v4.2 </option> </select> <div class="hidden lg:block"> <div class="flex items-center size-8 group" x-data="themeSwitcher" x-on:switch-theme.window="saveAndUpdate($event.detail)"> <button id="header__sun" @click="toSystemMode" title="Switch to system theme" class="size-8 cursor-default flex items-center justify-center text-sand-light-12 group-hover:text-sand-light-10 dark:text-sand-dark-12 dark:group-hover:text-sand-dark-10 transition duration-100 focus:outline-none focus:shadow-outline"> <svg class="size-6" width="24" height="24" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg"> <path d="M12.0002 3.29071V1.76746M5.8418 18.1585L4.7647 19.2356M12.0002 22.2326V20.7093M19.2357 4.76456L18.1586 5.84166M20.7095 12H22.2327M18.1586 18.1584L19.2357 19.2355M1.76758 12H3.29083M4.76462 4.7645L5.84173 5.8416M15.7123 8.2877C17.7626 10.338 17.7626 13.6621 15.7123 15.7123C13.6621 17.7626 10.338 17.7626 8.2877 15.7123C6.23745 13.6621 6.23745 10.338 8.2877 8.2877C10.338 6.23745 13.6621 6.23745 15.7123 8.2877Z" stroke="currentColor" stroke-width="1.5" stroke-linecap="square" stroke-linejoin="round"/> </svg> </button> <button id="header__moon" @click="toLightMode" title="Switch to light mode" class="size-8 cursor-default flex items-center justify-center text-sand-light-12 group-hover:text-sand-light-10 dark:text-sand-dark-12 dark:group-hover:text-sand-dark-10 transition duration-100 focus:outline-none focus:shadow-outline"> <svg class="size-6" width="24" height="24" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg"> <path fill-rule="evenodd" clip-rule="evenodd" d="M20.2496 14.1987C19.5326 14.3951 18.7782 14.5 18 14.5C13.3056 14.5 9.5 10.6944 9.5 5.99999C9.5 5.22185 9.60487 4.4674 9.80124 3.75043C6.15452 4.72095 3.46777 8.04578 3.46777 11.9981C3.46777 16.7114 7.28864 20.5323 12.0019 20.5323C15.9543 20.5323 19.2791 17.8455 20.2496 14.1987ZM20.5196 12.5328C19.7378 12.8346 18.8882 13 18 13C14.134 13 11 9.86598 11 5.99999C11 5.11181 11.1654 4.26226 11.4671 3.48047C11.6142 3.09951 11.7935 2.73464 12.0019 2.38923C12.0888 2.24526 12.1807 2.10466 12.2774 1.9677C12.1858 1.96523 12.094 1.96399 12.0019 1.96399C11.4758 1.96399 10.9592 2.00448 10.455 2.0825C5.64774 2.8264 1.96777 6.98251 1.96777 11.9981C1.96777 17.5398 6.46021 22.0323 12.0019 22.0323C17.0176 22.0323 21.1737 18.3523 21.9176 13.545C21.9956 13.0408 22.0361 12.5242 22.0361 11.9981C22.0361 11.906 22.0348 11.8141 22.0323 11.7226C21.8953 11.8193 21.7547 11.9112 21.6107 11.9981C21.2653 12.2065 20.9005 12.3858 20.5196 12.5328Z" fill="currentColor"/> <path d="M16.3333 5.33333L17.5 3L18.6667 5.33333L21 6.5L18.6667 7.66667L17.5 10L16.3333 7.66667L14 6.5L16.3333 5.33333Z" fill="currentColor"/> </svg> </button> <button id="header__indeterminate" @click="toDarkMode" title="Switch to dark mode" class="size-8 cursor-default flex items-center justify-center text-sand-light-12 group-hover:text-sand-light-10 dark:text-sand-dark-12 dark:group-hover:text-sand-dark-10 transition duration-100 focus:outline-none focus:shadow-outline"> <svg class="size-6 dark:hidden" width="24" height="24" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg"> <path fill-rule="evenodd" clip-rule="evenodd" d="M20.5 12C20.5 16.6944 16.6944 20.5 12 20.5V3.5C16.6944 3.5 20.5 7.30558 20.5 12ZM12 22C17.5228 22 22 17.5228 22 12C22 6.47715 17.5228 2 12 2C6.47715 2 2 6.47715 2 12C2 17.5228 6.47715 22 12 22Z" fill="currentColor" /> </svg> <svg class="size-6 hidden dark:block" width="24" height="24" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg"> <path fill-rule="evenodd" clip-rule="evenodd" d="M20.5 12C20.5 16.6944 16.6944 20.5 12 20.5V3.5C16.6944 3.5 20.5 7.30558 20.5 12ZM12 22C17.5228 22 22 17.5228 22 12C22 6.47715 17.5228 2 12 2C6.47715 2 2 6.47715 2 12C2 17.5228 6.47715 22 12 22Z" fill="currentColor"/> </svg> </button> </div> </div> <button popovertarget="docs-nav-mobile" class="cursor-pointer ml-13 lg:hidden"> <svg class="w-6 h-6 text-sand-light-9 hamburger-menu" width="24" height="24" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg" > <path d="M2.75 7.25H21.25M2.75 16.75H21.25" stroke="currentColor" stroke-width="1.5" stroke-linecap="square" /> </svg> <svg class="w-6 h-6 text-sand-light-9 close-menu" width="24" height="24" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg" > <path d="M4.75 4.75L19.25 19.25M19.25 4.75L4.75 19.25" stroke="currentColor" stroke-width="1.5" stroke-linecap="square" /> </svg> </button> </div> </div> </nav> <div popover id="docs-nav-mobile" class="fixed w-full bg-transparent main-nav-popover top-(--popover-top-offset)"> <div class="px-5 py-8 h-[calc(100dvh-5.5rem)] relative overflow-auto border-b docs_sidebar bg-sand-light-1 dark:bg-sand-dark-1"> <div class="absolute top-5 right-8"> <div class="flex items-center size-8 group" x-data="themeSwitcher" x-on:switch-theme.window="saveAndUpdate($event.detail)"> <button id="header__sun" @click="toSystemMode" title="Switch to system theme" class="size-8 cursor-default flex items-center justify-center text-sand-light-12 group-hover:text-sand-light-10 dark:text-sand-dark-12 dark:group-hover:text-sand-dark-10 transition duration-100 focus:outline-none focus:shadow-outline"> <svg class="size-6" width="24" height="24" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg"> <path d="M12.0002 3.29071V1.76746M5.8418 18.1585L4.7647 19.2356M12.0002 22.2326V20.7093M19.2357 4.76456L18.1586 5.84166M20.7095 12H22.2327M18.1586 18.1584L19.2357 19.2355M1.76758 12H3.29083M4.76462 4.7645L5.84173 5.8416M15.7123 8.2877C17.7626 10.338 17.7626 13.6621 15.7123 15.7123C13.6621 17.7626 10.338 17.7626 8.2877 15.7123C6.23745 13.6621 6.23745 10.338 8.2877 8.2877C10.338 6.23745 13.6621 6.23745 15.7123 8.2877Z" stroke="currentColor" stroke-width="1.5" stroke-linecap="square" stroke-linejoin="round"/> </svg> </button> <button id="header__moon" @click="toLightMode" title="Switch to light mode" class="size-8 cursor-default flex items-center justify-center text-sand-light-12 group-hover:text-sand-light-10 dark:text-sand-dark-12 dark:group-hover:text-sand-dark-10 transition duration-100 focus:outline-none focus:shadow-outline"> <svg class="size-6" width="24" height="24" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg"> <path fill-rule="evenodd" clip-rule="evenodd" d="M20.2496 14.1987C19.5326 14.3951 18.7782 14.5 18 14.5C13.3056 14.5 9.5 10.6944 9.5 5.99999C9.5 5.22185 9.60487 4.4674 9.80124 3.75043C6.15452 4.72095 3.46777 8.04578 3.46777 11.9981C3.46777 16.7114 7.28864 20.5323 12.0019 20.5323C15.9543 20.5323 19.2791 17.8455 20.2496 14.1987ZM20.5196 12.5328C19.7378 12.8346 18.8882 13 18 13C14.134 13 11 9.86598 11 5.99999C11 5.11181 11.1654 4.26226 11.4671 3.48047C11.6142 3.09951 11.7935 2.73464 12.0019 2.38923C12.0888 2.24526 12.1807 2.10466 12.2774 1.9677C12.1858 1.96523 12.094 1.96399 12.0019 1.96399C11.4758 1.96399 10.9592 2.00448 10.455 2.0825C5.64774 2.8264 1.96777 6.98251 1.96777 11.9981C1.96777 17.5398 6.46021 22.0323 12.0019 22.0323C17.0176 22.0323 21.1737 18.3523 21.9176 13.545C21.9956 13.0408 22.0361 12.5242 22.0361 11.9981C22.0361 11.906 22.0348 11.8141 22.0323 11.7226C21.8953 11.8193 21.7547 11.9112 21.6107 11.9981C21.2653 12.2065 20.9005 12.3858 20.5196 12.5328Z" fill="currentColor"/> <path d="M16.3333 5.33333L17.5 3L18.6667 5.33333L21 6.5L18.6667 7.66667L17.5 10L16.3333 7.66667L14 6.5L16.3333 5.33333Z" fill="currentColor"/> </svg> </button> <button id="header__indeterminate" @click="toDarkMode" title="Switch to dark mode" class="size-8 cursor-default flex items-center justify-center text-sand-light-12 group-hover:text-sand-light-10 dark:text-sand-dark-12 dark:group-hover:text-sand-dark-10 transition duration-100 focus:outline-none focus:shadow-outline"> <svg class="size-6 dark:hidden" width="24" height="24" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg"> <path fill-rule="evenodd" clip-rule="evenodd" d="M20.5 12C20.5 16.6944 16.6944 20.5 12 20.5V3.5C16.6944 3.5 20.5 7.30558 20.5 12ZM12 22C17.5228 22 22 17.5228 22 12C22 6.47715 17.5228 2 12 2C6.47715 2 2 6.47715 2 12C2 17.5228 6.47715 22 12 22Z" fill="currentColor" /> </svg> <svg class="size-6 hidden dark:block" width="24" height="24" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg"> <path fill-rule="evenodd" clip-rule="evenodd" d="M20.5 12C20.5 16.6944 16.6944 20.5 12 20.5V3.5C16.6944 3.5 20.5 7.30558 20.5 12ZM12 22C17.5228 22 22 17.5228 22 12C22 6.47715 17.5228 2 12 2C6.47715 2 2 6.47715 2 12C2 17.5228 6.47715 22 12 22Z" fill="currentColor"/> </svg> </button> </div> </div> <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="https://api.laravel.com/docs/11.x">API Documentation</a></li> </ul> </div> </div> <div class="px-4 xl:px-16"> <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="grid grid-cols-12 gap-4 lg:gap-6 xl:gap-x-10 px-6 mt-10 lg:px-0" id="docsScreen"> <aside class="relative col-span-3 lg:pb-6"> <div class="sticky bottom-0 left-0 z-20 hidden top-22 lg:block"> <div class="relative flex flex-col flex-1 max-h-screen pl-16 -ml-16 overflow-auto sticky-side-nav"> <nav id="indexed-nav" class="hidden lg:block"> <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="https://api.laravel.com/docs/11.x">API Documentation</a></li> </ul> </div> </nav> </div> </div> </aside> <section class="col-span-12 lg:col-span-9 xl:col-span-6"> <div> <section> <section class="docs_main max-w-prose"> <blockquote> <div class="callout"> <div class="flex flex-col p-3 mb-10 space-y-4 text-base leading-normal border rounded-md lg:flex-row lg:space-y-0 lg:space-x-4 border-sand-light-5 callout dark:border-sand-dark-5 dark:text-sand-light-3 text-sand-dark-3"> <div class="w-8 h-8 p-2 rounded-xs flex items-center justify-center shrink-0 bg-[#F53003]"> <svg width="2" height="18" viewBox="0 0 2 18" fill="none" xmlns="http://www.w3.org/2000/svg"> <path d="M1 17V16.99M1 1V13" stroke="#FDFDFC" stroke-width="2" stroke-linecap="square"/> </svg> </div> <p> <strong>WARNING</strong> You're browsing the documentation for an old version of Laravel. Consider upgrading your project to <a href="https://laravel.com/docs/12.x">Laravel 12.x</a>. </p> </div> </div> </blockquote> <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:#4c5374; text-align: right; -webkit-user-select: none; user-select: none;" class="line-number">1</span><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><div aria-hidden='true' hidden tabindex='-1' style='display: none;' class='torchlight-copy-target'> composer require laravel/sail --dev</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:#4c5374; text-align: right; -webkit-user-select: none; user-select: none;" class="line-number">1</span><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><div aria-hidden='true' hidden tabindex='-1' style='display: none;' class='torchlight-copy-target'> php artisan sail:install</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:#4c5374; text-align: right; -webkit-user-select: none; user-select: none;" class="line-number">1</span><span style="color: #BFC7D5;">./vendor/bin/sail </span><span style="color: #BFC7D5;">up</span></div><div aria-hidden='true' hidden tabindex='-1' style='display: none;' class='torchlight-copy-target'> ./vendor/bin/sail up</div></code></pre> </div> <div class="flex flex-col p-3 mb-10 space-y-4 text-base leading-normal border rounded-md lg:flex-row lg:space-y-0 lg:space-x-4 border-sand-light-5 callout dark:border-sand-dark-5 dark:text-sand-light-3 text-sand-dark-3"> <div class="w-8 h-8 p-2 rounded-xs flex items-center justify-center shrink-0 bg-[#F53003]"> <svg width="2" height="18" viewBox="0 0 2 18" fill="none" xmlns="http://www.w3.org/2000/svg"> <path d="M1 17V16.99M1 1V13" stroke="#FDFDFC" stroke-width="2" stroke-linecap="square"/> </svg> </div> <p class="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:#4c5374; text-align: right; -webkit-user-select: none; user-select: none;" class="line-number">1</span><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><div aria-hidden='true' hidden tabindex='-1' style='display: none;' class='torchlight-copy-target'> php artisan sail:add</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:#4c5374; text-align: right; -webkit-user-select: none; user-select: none;" class="line-number">1</span><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><div aria-hidden='true' hidden tabindex='-1' style='display: none;' class='torchlight-copy-target'> php artisan sail:install --devcontainer</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:#4c5374; text-align: right; -webkit-user-select: none; user-select: none;" class="line-number">1</span><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'><span style="color:#4c5374; text-align: right; -webkit-user-select: none; user-select: none;" class="line-number">2</span> </div><div class='line'><span style="color:#4c5374; text-align: right; -webkit-user-select: none; user-select: none;" class="line-number">3</span><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'><span style="color:#4c5374; text-align: right; -webkit-user-select: none; user-select: none;" class="line-number">4</span> </div><div class='line'><span style="color:#4c5374; text-align: right; -webkit-user-select: none; user-select: none;" class="line-number">5</span><span style="color: #BFC7D5;">sail </span><span style="color: #BFC7D5;">up</span></div><div aria-hidden='true' hidden tabindex='-1' style='display: none;' class='torchlight-copy-target'> docker compose down -v sail build --no-cache sail up</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:#4c5374; text-align: right; -webkit-user-select: none; user-select: none;" class="line-number">1</span><span style="color: #BFC7D5;">./vendor/bin/sail </span><span style="color: #BFC7D5;">up</span></div><div aria-hidden='true' hidden tabindex='-1' style='display: none;' class='torchlight-copy-target'> ./vendor/bin/sail up</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:#4c5374; text-align: right; -webkit-user-select: none; user-select: none;" class="line-number">1</span><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><div aria-hidden='true' hidden tabindex='-1' style='display: none;' class='torchlight-copy-target'> alias sail='sh $([ -f sail ] && echo sail || echo vendor/bin/sail)'</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:#4c5374; text-align: right; -webkit-user-select: none; user-select: none;" class="line-number">1</span><span style="color: #BFC7D5;">sail </span><span style="color: #BFC7D5;">up</span></div><div aria-hidden='true' hidden tabindex='-1' style='display: none;' class='torchlight-copy-target'> sail up</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:#4c5374; text-align: right; -webkit-user-select: none; user-select: none;" class="line-number">1</span><span style="color: #BFC7D5;">sail </span><span style="color: #BFC7D5;">up</span></div><div aria-hidden='true' hidden tabindex='-1' style='display: none;' class='torchlight-copy-target'> sail up</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:#4c5374; text-align: right; -webkit-user-select: none; user-select: none;" class="line-number">1</span><span style="color: #BFC7D5;">sail </span><span style="color: #BFC7D5;">up</span><span style="color: #BFC7D5;"> </span><span style="color: #82AAFF;">-d</span></div><div aria-hidden='true' hidden tabindex='-1' style='display: none;' class='torchlight-copy-target'> sail up -d</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:#4c5374; text-align: right; -webkit-user-select: none; user-select: none;" class="line-number">1</span><span style="color: #BFC7D5;">sail </span><span style="color: #BFC7D5;">stop</span></div><div aria-hidden='true' hidden tabindex='-1' style='display: none;' class='torchlight-copy-target'> sail stop</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:#4c5374; text-align: right; -webkit-user-select: none; user-select: none;" class="line-number">1</span><span style="color: #697098;">#</span><span style="color: #697098;"> Running Artisan commands locally...</span></div><div class='line'><span style="color:#4c5374; text-align: right; -webkit-user-select: none; user-select: none;" class="line-number">2</span><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'><span style="color:#4c5374; text-align: right; -webkit-user-select: none; user-select: none;" class="line-number">3</span> </div><div class='line'><span style="color:#4c5374; text-align: right; -webkit-user-select: none; user-select: none;" class="line-number">4</span><span style="color: #697098;">#</span><span style="color: #697098;"> Running Artisan commands within Laravel Sail...</span></div><div class='line'><span style="color:#4c5374; text-align: right; -webkit-user-select: none; user-select: none;" class="line-number">5</span><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><div aria-hidden='true' hidden tabindex='-1' style='display: none;' class='torchlight-copy-target'> # Running Artisan commands locally... php artisan queue:work # Running Artisan commands within Laravel Sail... sail artisan queue:work</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:#4c5374; text-align: right; -webkit-user-select: none; user-select: none;" class="line-number">1</span><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'><span style="color:#4c5374; text-align: right; -webkit-user-select: none; user-select: none;" class="line-number">2</span> </div><div class='line'><span style="color:#4c5374; text-align: right; -webkit-user-select: none; user-select: none;" class="line-number">3</span><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><div aria-hidden='true' hidden tabindex='-1' style='display: none;' class='torchlight-copy-target'> sail php --version sail php script.php</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:#4c5374; text-align: right; -webkit-user-select: none; user-select: none;" class="line-number">1</span><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><div aria-hidden='true' hidden tabindex='-1' style='display: none;' class='torchlight-copy-target'> sail composer require laravel/sanctum</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:#4c5374; text-align: right; -webkit-user-select: none; user-select: none;" class="line-number">1</span><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:#4c5374; text-align: right; -webkit-user-select: none; user-select: none;" class="line-number">2</span><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:#4c5374; text-align: right; -webkit-user-select: none; user-select: none;" class="line-number">3</span><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:#4c5374; text-align: right; -webkit-user-select: none; user-select: none;" class="line-number">4</span><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:#4c5374; text-align: right; -webkit-user-select: none; user-select: none;" class="line-number">5</span><span style="color: #BFC7D5;"> laravelsail/php84-composer:latest </span><span style="color: #F78C6C;">\</span></div><div class='line'><span style="color:#4c5374; text-align: right; -webkit-user-select: none; user-select: none;" class="line-number">6</span><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><div aria-hidden='true' hidden tabindex='-1' style='display: none;' class='torchlight-copy-target'> docker run --rm \ -u "$(id -u):$(id -g)" \ -v "$(pwd):/var/www/html" \ -w /var/www/html \ laravelsail/php84-composer:latest \ composer install --ignore-platform-reqs</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:#4c5374; text-align: right; -webkit-user-select: none; user-select: none;" class="line-number">1</span><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><div aria-hidden='true' hidden tabindex='-1' style='display: none;' class='torchlight-copy-target'> sail artisan queue:work</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:#4c5374; text-align: right; -webkit-user-select: none; user-select: none;" class="line-number">1</span><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'><span style="color:#4c5374; text-align: right; -webkit-user-select: none; user-select: none;" class="line-number">2</span> </div><div class='line'><span style="color:#4c5374; text-align: right; -webkit-user-select: none; user-select: none;" class="line-number">3</span><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><div aria-hidden='true' hidden tabindex='-1' style='display: none;' class='torchlight-copy-target'> sail node --version sail npm run dev</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:#4c5374; text-align: right; -webkit-user-select: none; user-select: none;" class="line-number">1</span><span style="color: #BFC7D5;">sail </span><span style="color: #BFC7D5;">yarn</span></div><div aria-hidden='true' hidden tabindex='-1' style='display: none;' class='torchlight-copy-target'> sail yarn</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:#4c5374; text-align: right; -webkit-user-select: none; user-select: none;" class="line-number">1</span><span style="color: #C792EA;">MONGODB_USERNAME</span><span style="color: #BFC7D5;">=user</span></div><div class='line'><span style="color:#4c5374; text-align: right; -webkit-user-select: none; user-select: none;" class="line-number">2</span><span style="color: #C792EA;">MONGODB_PASSWORD</span><span style="color: #BFC7D5;">=laravel</span></div><div class='line'><span style="color:#4c5374; text-align: right; -webkit-user-select: none; user-select: none;" class="line-number">3</span><span style="color: #C792EA;">MONGODB_URI</span><span style="color: #BFC7D5;">=mongodb://${MONGODB_USERNAME}:${MONGODB_PASSWORD}@mongodb:27017</span></div><div aria-hidden='true' hidden tabindex='-1' style='display: none;' class='torchlight-copy-target'> MONGODB_USERNAME=user MONGODB_PASSWORD=laravel MONGODB_URI=mongodb://${MONGODB_USERNAME}:${MONGODB_PASSWORD}@mongodb:27017</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:#4c5374; text-align: right; -webkit-user-select: none; user-select: none;" class="line-number">1</span><span style="color: #C792EA;">TYPESENSE_HOST</span><span style="color: #BFC7D5;">=typesense</span></div><div class='line'><span style="color:#4c5374; text-align: right; -webkit-user-select: none; user-select: none;" class="line-number">2</span><span style="color: #C792EA;">TYPESENSE_PORT</span><span style="color: #BFC7D5;">=8108</span></div><div class='line'><span style="color:#4c5374; text-align: right; -webkit-user-select: none; user-select: none;" class="line-number">3</span><span style="color: #C792EA;">TYPESENSE_PROTOCOL</span><span style="color: #BFC7D5;">=http</span></div><div class='line'><span style="color:#4c5374; text-align: right; -webkit-user-select: none; user-select: none;" class="line-number">4</span><span style="color: #C792EA;">TYPESENSE_API_KEY</span><span style="color: #BFC7D5;">=xyz</span></div><div aria-hidden='true' hidden tabindex='-1' style='display: none;' class='torchlight-copy-target'> TYPESENSE_HOST=typesense TYPESENSE_PORT=8108 TYPESENSE_PROTOCOL=http TYPESENSE_API_KEY=xyz</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:#4c5374; text-align: right; -webkit-user-select: none; user-select: none;" class="line-number">1</span><span style="color: #C792EA;">FILESYSTEM_DISK</span><span style="color: #BFC7D5;">=s3</span></div><div class='line'><span style="color:#4c5374; text-align: right; -webkit-user-select: none; user-select: none;" class="line-number">2</span><span style="color: #C792EA;">AWS_ACCESS_KEY_ID</span><span style="color: #BFC7D5;">=sail</span></div><div class='line'><span style="color:#4c5374; text-align: right; -webkit-user-select: none; user-select: none;" class="line-number">3</span><span style="color: #C792EA;">AWS_SECRET_ACCESS_KEY</span><span style="color: #BFC7D5;">=password</span></div><div class='line'><span style="color:#4c5374; text-align: right; -webkit-user-select: none; user-select: none;" class="line-number">4</span><span style="color: #C792EA;">AWS_DEFAULT_REGION</span><span style="color: #BFC7D5;">=us-east-1</span></div><div class='line'><span style="color:#4c5374; text-align: right; -webkit-user-select: none; user-select: none;" class="line-number">5</span><span style="color: #C792EA;">AWS_BUCKET</span><span style="color: #BFC7D5;">=local</span></div><div class='line'><span style="color:#4c5374; text-align: right; -webkit-user-select: none; user-select: none;" class="line-number">6</span><span style="color: #C792EA;">AWS_ENDPOINT</span><span style="color: #BFC7D5;">=http://minio:9000</span></div><div class='line'><span style="color:#4c5374; text-align: right; -webkit-user-select: none; user-select: none;" class="line-number">7</span><span style="color: #C792EA;">AWS_USE_PATH_STYLE_ENDPOINT</span><span style="color: #BFC7D5;">=true</span></div><div aria-hidden='true' hidden tabindex='-1' style='display: none;' class='torchlight-copy-target'> FILESYSTEM_DISK=s3 AWS_ACCESS_KEY_ID=sail AWS_SECRET_ACCESS_KEY=password AWS_DEFAULT_REGION=us-east-1 AWS_BUCKET=local AWS_ENDPOINT=http://minio:9000 AWS_USE_PATH_STYLE_ENDPOINT=true</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:#4c5374; text-align: right; -webkit-user-select: none; user-select: none;" class="line-number">1</span><span style="color: #C792EA;">AWS_URL</span><span style="color: #BFC7D5;">=http://localhost:9000/local</span></div><div aria-hidden='true' hidden tabindex='-1' style='display: none;' class='torchlight-copy-target'> AWS_URL=http://localhost:9000/local</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="flex flex-col p-3 mb-10 space-y-4 text-base leading-normal border rounded-md lg:flex-row lg:space-y-0 lg:space-x-4 border-sand-light-5 callout dark:border-sand-dark-5 dark:text-sand-light-3 text-sand-dark-3"> <div class="w-8 h-8 p-2 rounded-xs flex items-center justify-center shrink-0 bg-[#F53003]"> <svg width="2" height="18" viewBox="0 0 2 18" fill="none" xmlns="http://www.w3.org/2000/svg"> <path d="M1 17V16.99M1 1V13" stroke="#FDFDFC" stroke-width="2" stroke-linecap="square"/> </svg> </div> <p class="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:#4c5374; text-align: right; -webkit-user-select: none; user-select: none;" class="line-number">1</span><span style="color: #BFC7D5;">sail </span><span style="color: #BFC7D5;">test</span></div><div class='line'><span style="color:#4c5374; text-align: right; -webkit-user-select: none; user-select: none;" class="line-number">2</span> </div><div class='line'><span style="color:#4c5374; text-align: right; -webkit-user-select: none; user-select: none;" class="line-number">3</span><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><div aria-hidden='true' hidden tabindex='-1' style='display: none;' class='torchlight-copy-target'> sail test sail test --group orders</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:#4c5374; text-align: right; -webkit-user-select: none; user-select: none;" class="line-number">1</span><span style="color: #BFC7D5;">sail </span><span style="color: #BFC7D5;">artisan</span><span style="color: #BFC7D5;"> </span><span style="color: #BFC7D5;">test</span></div><div aria-hidden='true' hidden tabindex='-1' style='display: none;' class='torchlight-copy-target'> sail artisan test</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:#4c5374; text-align: right; -webkit-user-select: none; user-select: none;" class="line-number">1</span><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><div aria-hidden='true' hidden tabindex='-1' style='display: none;' class='torchlight-copy-target'> <env name="DB_DATABASE" value="testing"/></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:#4c5374; text-align: right; -webkit-user-select: none; user-select: none;" class="line-number">1</span><span style="color: #89DDFF;">selenium</span><span style="color: #BFC7D5;">:</span></div><div class='line'><span style="color:#4c5374; text-align: right; -webkit-user-select: none; user-select: none;" class="line-number">2</span><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:#4c5374; text-align: right; -webkit-user-select: none; user-select: none;" class="line-number">3</span><span style="color: #BFC7D5;"> </span><span style="color: #89DDFF;">extra_hosts</span><span style="color: #BFC7D5;">:</span></div><div class='line'><span style="color:#4c5374; text-align: right; -webkit-user-select: none; user-select: none;" class="line-number">4</span><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:#4c5374; text-align: right; -webkit-user-select: none; user-select: none;" class="line-number">5</span><span style="color: #BFC7D5;"> </span><span style="color: #89DDFF;">volumes</span><span style="color: #BFC7D5;">:</span></div><div class='line'><span style="color:#4c5374; text-align: right; -webkit-user-select: none; user-select: none;" class="line-number">6</span><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:#4c5374; text-align: right; -webkit-user-select: none; user-select: none;" class="line-number">7</span><span style="color: #BFC7D5;"> </span><span style="color: #89DDFF;">networks</span><span style="color: #BFC7D5;">:</span></div><div class='line'><span style="color:#4c5374; text-align: right; -webkit-user-select: none; user-select: none;" class="line-number">8</span><span style="color: #BFC7D5;"> - </span><span style="color: #BFC7D5;">sail</span></div><div aria-hidden='true' hidden tabindex='-1' style='display: none;' class='torchlight-copy-target'> selenium: image: 'selenium/standalone-chrome' extra_hosts: - 'host.docker.internal:host-gateway' volumes: - '/dev/shm:/dev/shm' networks: - sail</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:#4c5374; text-align: right; -webkit-user-select: none; user-select: none;" class="line-number">1</span><span style="color: #89DDFF;">depends_on</span><span style="color: #BFC7D5;">:</span></div><div class='line'><span style="color:#4c5374; text-align: right; -webkit-user-select: none; user-select: none;" class="line-number">2</span><span style="color: #BFC7D5;"> - </span><span style="color: #BFC7D5;">mysql</span></div><div class='line'><span style="color:#4c5374; text-align: right; -webkit-user-select: none; user-select: none;" class="line-number">3</span><span style="color: #BFC7D5;"> - </span><span style="color: #BFC7D5;">redis</span></div><div class='line'><span style="color:#4c5374; text-align: right; -webkit-user-select: none; user-select: none;" class="line-number">4</span><span style="color: #BFC7D5;"> - </span><span style="color: #BFC7D5;">selenium</span></div><div aria-hidden='true' hidden tabindex='-1' style='display: none;' class='torchlight-copy-target'> depends_on: - mysql - redis - selenium</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:#4c5374; text-align: right; -webkit-user-select: none; user-select: none;" class="line-number">1</span><span style="color: #BFC7D5;">sail </span><span style="color: #BFC7D5;">dusk</span></div><div aria-hidden='true' hidden tabindex='-1' style='display: none;' class='torchlight-copy-target'> sail dusk</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:#4c5374; text-align: right; -webkit-user-select: none; user-select: none;" class="line-number">1</span><span style="color: #89DDFF;">selenium</span><span style="color: #BFC7D5;">:</span></div><div class='line'><span style="color:#4c5374; text-align: right; -webkit-user-select: none; user-select: none;" class="line-number">2</span><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:#4c5374; text-align: right; -webkit-user-select: none; user-select: none;" class="line-number">3</span><span style="color: #BFC7D5;"> </span><span style="color: #89DDFF;">extra_hosts</span><span style="color: #BFC7D5;">:</span></div><div class='line'><span style="color:#4c5374; text-align: right; -webkit-user-select: none; user-select: none;" class="line-number">4</span><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:#4c5374; text-align: right; -webkit-user-select: none; user-select: none;" class="line-number">5</span><span style="color: #BFC7D5;"> </span><span style="color: #89DDFF;">volumes</span><span style="color: #BFC7D5;">:</span></div><div class='line'><span style="color:#4c5374; text-align: right; -webkit-user-select: none; user-select: none;" class="line-number">6</span><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:#4c5374; text-align: right; -webkit-user-select: none; user-select: none;" class="line-number">7</span><span style="color: #BFC7D5;"> </span><span style="color: #89DDFF;">networks</span><span style="color: #BFC7D5;">:</span></div><div class='line'><span style="color:#4c5374; text-align: right; -webkit-user-select: none; user-select: none;" class="line-number">8</span><span style="color: #BFC7D5;"> - </span><span style="color: #BFC7D5;">sail</span></div><div aria-hidden='true' hidden tabindex='-1' style='display: none;' class='torchlight-copy-target'> selenium: image: 'selenium/standalone-chromium' extra_hosts: - 'host.docker.internal:host-gateway' volumes: - '/dev/shm:/dev/shm' networks: - sail</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:#4c5374; text-align: right; -webkit-user-select: none; user-select: none;" class="line-number">1</span><span style="color: #C792EA;">MAIL_HOST</span><span style="color: #BFC7D5;">=mailpit</span></div><div class='line'><span style="color:#4c5374; text-align: right; -webkit-user-select: none; user-select: none;" class="line-number">2</span><span style="color: #C792EA;">MAIL_PORT</span><span style="color: #BFC7D5;">=1025</span></div><div class='line'><span style="color:#4c5374; text-align: right; -webkit-user-select: none; user-select: none;" class="line-number">3</span><span style="color: #C792EA;">MAIL_ENCRYPTION</span><span style="color: #BFC7D5;">=null</span></div><div aria-hidden='true' hidden tabindex='-1' style='display: none;' class='torchlight-copy-target'> MAIL_HOST=mailpit MAIL_PORT=1025 MAIL_ENCRYPTION=null</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:#4c5374; text-align: right; -webkit-user-select: none; user-select: none;" class="line-number">1</span><span style="color: #BFC7D5;">sail </span><span style="color: #BFC7D5;">shell</span></div><div class='line'><span style="color:#4c5374; text-align: right; -webkit-user-select: none; user-select: none;" class="line-number">2</span> </div><div class='line'><span style="color:#4c5374; text-align: right; -webkit-user-select: none; user-select: none;" class="line-number">3</span><span style="color: #BFC7D5;">sail </span><span style="color: #BFC7D5;">root-shell</span></div><div aria-hidden='true' hidden tabindex='-1' style='display: none;' class='torchlight-copy-target'> sail shell sail root-shell</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:#4c5374; text-align: right; -webkit-user-select: none; user-select: none;" class="line-number">1</span><span style="color: #BFC7D5;">sail </span><span style="color: #BFC7D5;">tinker</span></div><div aria-hidden='true' hidden tabindex='-1' style='display: none;' class='torchlight-copy-target'> sail tinker</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:#4c5374; text-align: right; -webkit-user-select: none; user-select: none;" class="line-number"> 1</span><span style="color: #697098;">#</span><span style="color: #697098;"> PHP 8.4</span></div><div class='line'><span style="color:#4c5374; text-align: right; -webkit-user-select: none; user-select: none;" class="line-number"> 2</span><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'><span style="color:#4c5374; text-align: right; -webkit-user-select: none; user-select: none;" class="line-number"> 3</span> </div><div class='line'><span style="color:#4c5374; text-align: right; -webkit-user-select: none; user-select: none;" class="line-number"> 4</span><span style="color: #697098;">#</span><span style="color: #697098;"> PHP 8.3</span></div><div class='line'><span style="color:#4c5374; text-align: right; -webkit-user-select: none; user-select: none;" class="line-number"> 5</span><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'><span style="color:#4c5374; text-align: right; -webkit-user-select: none; user-select: none;" class="line-number"> 6</span> </div><div class='line'><span style="color:#4c5374; text-align: right; -webkit-user-select: none; user-select: none;" class="line-number"> 7</span><span style="color: #697098;">#</span><span style="color: #697098;"> PHP 8.2</span></div><div class='line'><span style="color:#4c5374; text-align: right; -webkit-user-select: none; user-select: none;" class="line-number"> 8</span><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'><span style="color:#4c5374; text-align: right; -webkit-user-select: none; user-select: none;" class="line-number"> 9</span> </div><div class='line'><span style="color:#4c5374; text-align: right; -webkit-user-select: none; user-select: none;" class="line-number">10</span><span style="color: #697098;">#</span><span style="color: #697098;"> PHP 8.1</span></div><div class='line'><span style="color:#4c5374; text-align: right; -webkit-user-select: none; user-select: none;" class="line-number">11</span><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'><span style="color:#4c5374; text-align: right; -webkit-user-select: none; user-select: none;" class="line-number">12</span> </div><div class='line'><span style="color:#4c5374; text-align: right; -webkit-user-select: none; user-select: none;" class="line-number">13</span><span style="color: #697098;">#</span><span style="color: #697098;"> PHP 8.0</span></div><div class='line'><span style="color:#4c5374; text-align: right; -webkit-user-select: none; user-select: none;" class="line-number">14</span><span style="color: #89DDFF;">context</span><span style="color: #BFC7D5;">: </span><span style="color: #BFC7D5;">./vendor/laravel/sail/runtimes/8.0</span></div><div aria-hidden='true' hidden tabindex='-1' style='display: none;' class='torchlight-copy-target'> # PHP 8.4 context: ./vendor/laravel/sail/runtimes/8.4 # PHP 8.3 context: ./vendor/laravel/sail/runtimes/8.3 # PHP 8.2 context: ./vendor/laravel/sail/runtimes/8.2 # PHP 8.1 context: ./vendor/laravel/sail/runtimes/8.1 # PHP 8.0 context: ./vendor/laravel/sail/runtimes/8.0</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:#4c5374; text-align: right; -webkit-user-select: none; user-select: none;" class="line-number">1</span><span style="color: #89DDFF;">image</span><span style="color: #BFC7D5;">: </span><span style="color: #BFC7D5;">sail-8.2/app</span></div><div aria-hidden='true' hidden tabindex='-1' style='display: none;' class='torchlight-copy-target'> image: sail-8.2/app</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:#4c5374; text-align: right; -webkit-user-select: none; user-select: none;" class="line-number">1</span><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'><span style="color:#4c5374; text-align: right; -webkit-user-select: none; user-select: none;" class="line-number">2</span> </div><div class='line'><span style="color:#4c5374; text-align: right; -webkit-user-select: none; user-select: none;" class="line-number">3</span><span style="color: #BFC7D5;">sail </span><span style="color: #BFC7D5;">up</span></div><div aria-hidden='true' hidden tabindex='-1' style='display: none;' class='torchlight-copy-target'> sail build --no-cache sail up</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:#4c5374; text-align: right; -webkit-user-select: none; user-select: none;" class="line-number">1</span><span style="color: #89DDFF;">build</span><span style="color: #BFC7D5;">:</span></div><div class='line'><span style="color:#4c5374; text-align: right; -webkit-user-select: none; user-select: none;" class="line-number">2</span><span style="color: #BFC7D5;"> </span><span style="color: #89DDFF;">args</span><span style="color: #BFC7D5;">:</span></div><div class='line'><span style="color:#4c5374; text-align: right; -webkit-user-select: none; user-select: none;" class="line-number">3</span><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:#4c5374; text-align: right; -webkit-user-select: none; user-select: none;" class="line-number">4</span><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><div aria-hidden='true' hidden tabindex='-1' style='display: none;' class='torchlight-copy-target'> build: args: WWWGROUP: '${WWWGROUP}' NODE_VERSION: '18'</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:#4c5374; text-align: right; -webkit-user-select: none; user-select: none;" class="line-number">1</span><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'><span style="color:#4c5374; text-align: right; -webkit-user-select: none; user-select: none;" class="line-number">2</span> </div><div class='line'><span style="color:#4c5374; text-align: right; -webkit-user-select: none; user-select: none;" class="line-number">3</span><span style="color: #BFC7D5;">sail </span><span style="color: #BFC7D5;">up</span></div><div aria-hidden='true' hidden tabindex='-1' style='display: none;' class='torchlight-copy-target'> sail build --no-cache sail up</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:#4c5374; text-align: right; -webkit-user-select: none; user-select: none;" class="line-number">1</span><span style="color: #BFC7D5;">sail </span><span style="color: #BFC7D5;">share</span></div><div aria-hidden='true' hidden tabindex='-1' style='display: none;' class='torchlight-copy-target'> sail share</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:#4c5374; text-align: right; -webkit-user-select: none; user-select: none;" class="line-number">1</span><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:#4c5374; text-align: right; -webkit-user-select: none; user-select: none;" class="line-number">2</span><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:#4c5374; text-align: right; -webkit-user-select: none; user-select: none;" class="line-number">3</span><span style="color: #BFC7D5;">})</span></div><div aria-hidden='true' hidden tabindex='-1' style='display: none;' class='torchlight-copy-target'> ->withMiddleware(function (Middleware $middleware) { $middleware->trustProxies(at: '*'); })</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:#4c5374; text-align: right; -webkit-user-select: none; user-select: none;" class="line-number">1</span><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><div aria-hidden='true' hidden tabindex='-1' style='display: none;' class='torchlight-copy-target'> sail share --subdomain=my-sail-site</div></code></pre> </div> <div class="flex flex-col p-3 mb-10 space-y-4 text-base leading-normal border rounded-md lg:flex-row lg:space-y-0 lg:space-x-4 border-sand-light-5 callout dark:border-sand-dark-5 dark:text-sand-light-3 text-sand-dark-3"> <div class="w-8 h-8 p-2 rounded-xs flex items-center justify-center shrink-0 bg-[#8D54C5]"> <svg width="16" height="21" viewBox="0 0 16 21" fill="none" xmlns="http://www.w3.org/2000/svg"> <path d="M5 20H11M5.5 14H10.5M15 8C15 4.13401 11.866 1 8 1C4.13401 1 1 4.13401 1 8C1 10.7924 2.63505 13.2029 5 14.3264V17H11V14.3264C13.3649 13.2029 15 10.7924 15 8Z" stroke="#FDFDFC" stroke-width="1.5" stroke-linecap="square"/> </svg> </div> <p class="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:#4c5374; text-align: right; -webkit-user-select: none; user-select: none;" class="line-number">1</span><span style="color: #C792EA;">SAIL_XDEBUG_MODE</span><span style="color: #BFC7D5;">=develop,debug,coverage</span></div><div aria-hidden='true' hidden tabindex='-1' style='display: none;' class='torchlight-copy-target'> SAIL_XDEBUG_MODE=develop,debug,coverage</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:#4c5374; text-align: right; -webkit-user-select: none; user-select: none;" class="line-number">1</span><span style="color: #BFC7D5;">[xdebug]</span></div><div class='line'><span style="color:#4c5374; text-align: right; -webkit-user-select: none; user-select: none;" class="line-number">2</span><span style="color: #C792EA;">xdebug.mode</span><span style="color: #BFC7D5;">=${XDEBUG_MODE}</span></div><div aria-hidden='true' hidden tabindex='-1' style='display: none;' class='torchlight-copy-target'> [xdebug] xdebug.mode=${XDEBUG_MODE}</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:#4c5374; text-align: right; -webkit-user-select: none; user-select: none;" class="line-number">1</span><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 aria-hidden='true' hidden tabindex='-1' style='display: none;' class='torchlight-copy-target'> sail build --no-cache</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:#4c5374; text-align: right; -webkit-user-select: none; user-select: none;" class="line-number"> 1</span><span style="color: #89DDFF;">networks</span><span style="color: #BFC7D5;">:</span></div><div class='line'><span style="color:#4c5374; text-align: right; -webkit-user-select: none; user-select: none;" class="line-number"> 2</span><span style="color: #BFC7D5;"> </span><span style="color: #89DDFF;">custom_network</span><span style="color: #BFC7D5;">:</span></div><div class='line'><span style="color:#4c5374; text-align: right; -webkit-user-select: none; user-select: none;" class="line-number"> 3</span><span style="color: #BFC7D5;"> </span><span style="color: #89DDFF;">ipam</span><span style="color: #BFC7D5;">:</span></div><div class='line'><span style="color:#4c5374; text-align: right; -webkit-user-select: none; user-select: none;" class="line-number"> 4</span><span style="color: #BFC7D5;"> </span><span style="color: #89DDFF;">config</span><span style="color: #BFC7D5;">:</span></div><div class='line'><span style="color:#4c5374; text-align: right; -webkit-user-select: none; user-select: none;" class="line-number"> 5</span><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'><span style="color:#4c5374; text-align: right; -webkit-user-select: none; user-select: none;" class="line-number"> 6</span> </div><div class='line'><span style="color:#4c5374; text-align: right; -webkit-user-select: none; user-select: none;" class="line-number"> 7</span><span style="color: #89DDFF;">services</span><span style="color: #BFC7D5;">:</span></div><div class='line'><span style="color:#4c5374; text-align: right; -webkit-user-select: none; user-select: none;" class="line-number"> 8</span><span style="color: #BFC7D5;"> </span><span style="color: #89DDFF;">laravel.test</span><span style="color: #BFC7D5;">:</span></div><div class='line'><span style="color:#4c5374; text-align: right; -webkit-user-select: none; user-select: none;" class="line-number"> 9</span><span style="color: #BFC7D5;"> </span><span style="color: #89DDFF;">networks</span><span style="color: #BFC7D5;">:</span></div><div class='line'><span style="color:#4c5374; text-align: right; -webkit-user-select: none; user-select: none;" class="line-number">10</span><span style="color: #BFC7D5;"> </span><span style="color: #89DDFF;">custom_network</span><span style="color: #BFC7D5;">:</span></div><div class='line'><span style="color:#4c5374; text-align: right; -webkit-user-select: none; user-select: none;" class="line-number">11</span><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><div aria-hidden='true' hidden tabindex='-1' style='display: none;' class='torchlight-copy-target'> networks: custom_network: ipam: config: - subnet: 172.20.0.0/16 services: laravel.test: networks: custom_network: ipv4_address: 172.20.0.2</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:#4c5374; text-align: right; -webkit-user-select: none; user-select: none;" class="line-number">1</span><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><div aria-hidden='true' hidden tabindex='-1' style='display: none;' class='torchlight-copy-target'> SAIL_XDEBUG_CONFIG="client_host=172.20.0.2"</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:#4c5374; text-align: right; -webkit-user-select: none; user-select: none;" class="line-number">1</span><span style="color: #697098;">#</span><span style="color: #697098;"> Run an Artisan command without Xdebug...</span></div><div class='line'><span style="color:#4c5374; text-align: right; -webkit-user-select: none; user-select: none;" class="line-number">2</span><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'><span style="color:#4c5374; text-align: right; -webkit-user-select: none; user-select: none;" class="line-number">3</span> </div><div class='line'><span style="color:#4c5374; text-align: right; -webkit-user-select: none; user-select: none;" class="line-number">4</span><span style="color: #697098;">#</span><span style="color: #697098;"> Run an Artisan command with Xdebug...</span></div><div class='line'><span style="color:#4c5374; text-align: right; -webkit-user-select: none; user-select: none;" class="line-number">5</span><span style="color: #BFC7D5;">sail </span><span style="color: #BFC7D5;">debug</span><span style="color: #BFC7D5;"> </span><span style="color: #BFC7D5;">migrate</span></div><div aria-hidden='true' hidden tabindex='-1' style='display: none;' class='torchlight-copy-target'> # Run an Artisan command without Xdebug... sail artisan migrate # Run an Artisan command with Xdebug... sail debug migrate</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="flex flex-col p-3 mb-10 space-y-4 text-base leading-normal border rounded-md lg:flex-row lg:space-y-0 lg:space-x-4 border-sand-light-5 callout dark:border-sand-dark-5 dark:text-sand-light-3 text-sand-dark-3"> <div class="w-8 h-8 p-2 rounded-xs flex items-center justify-center shrink-0 bg-[#F53003]"> <svg width="2" height="18" viewBox="0 0 2 18" fill="none" xmlns="http://www.w3.org/2000/svg"> <path d="M1 17V16.99M1 1V13" stroke="#FDFDFC" stroke-width="2" stroke-linecap="square"/> </svg> </div> <p class="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:#4c5374; text-align: right; -webkit-user-select: none; user-select: none;" class="line-number">1</span><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><div aria-hidden='true' hidden tabindex='-1' style='display: none;' class='torchlight-copy-target'> sail artisan sail:publish</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:#4c5374; text-align: right; -webkit-user-select: none; user-select: none;" class="line-number">1</span><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 aria-hidden='true' hidden tabindex='-1' style='display: none;' class='torchlight-copy-target'> sail build --no-cache</div></code></pre> </div> </div> </section> </section> </div> </section> </div> </div> </div> </div> <div class="text-sand-dark-10"> <div class="max-w-full w-full xl:max-w-[1400px] pt-10 md:pt-24 px-4 xl:px-16 mx-auto border-l border-sand-light-7"> <div class="grid grid-cols-12 lg:gap-12"> <div class="col-span-12 lg:col-span-3 lg:mt-14"> <p class="text-pretty">Laravel is the most productive way to<br class="block lg:hidden"> build, deploy, and monitor software.</p> <ul class="flex items-center justify-start my-8 space-x-6 lg:my-16"> <li> <a href="https://github.com/laravel" target="_blank" title="Laravel on GitHub" class="transition duration-100 hover:text-sand-dark-6"> <svg width="24" height="24" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg" > <path fill-rule="evenodd" clip-rule="evenodd" d="M0 12.305C0 17.74 3.438 22.352 8.207 23.979C8.807 24.092 9.027 23.712 9.027 23.386C9.027 23.094 9.016 22.32 9.01 21.293C5.671 22.037 4.967 19.643 4.967 19.643C4.422 18.223 3.635 17.845 3.635 17.845C2.545 17.081 3.718 17.096 3.718 17.096C4.921 17.183 5.555 18.364 5.555 18.364C6.626 20.244 8.364 19.702 9.048 19.386C9.157 18.591 9.468 18.049 9.81 17.741C7.145 17.431 4.344 16.376 4.344 11.661C4.344 10.318 4.811 9.219 5.579 8.359C5.456 8.048 5.044 6.797 5.696 5.103C5.696 5.103 6.704 4.773 8.996 6.364C9.954 6.091 10.98 5.955 12.001 5.95C13.02 5.955 14.047 6.091 15.005 6.364C17.295 4.772 18.302 5.103 18.302 5.103C18.956 6.797 18.544 8.048 18.421 8.359C19.191 9.219 19.655 10.318 19.655 11.661C19.655 16.387 16.849 17.428 14.175 17.732C14.606 18.112 14.99 18.862 14.99 20.011C14.99 21.656 14.975 22.982 14.975 23.386C14.975 23.715 15.191 24.098 15.8 23.977C20.565 22.347 24 17.738 24 12.305C24 5.508 18.627 0 12 0C5.373 0 0 5.508 0 12.305Z" fill="currentColor" /> </svg> </a> </li> <li> <a href="https://x.com/laravelphp" target="_blank" title="Laravel on X" class="transition duration-100 hover:text-sand-dark-6"> <svg width="24" height="24" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg" > <path d="M13.969 10.1571L22.7069 0H20.6363L13.0491 8.81931L6.9893 0H0L9.16366 13.3364L0 23.9877H2.07073L10.083 14.6742L16.4826 23.9877H23.4719L13.9684 10.1571H13.969ZM11.1328 13.4538L10.2043 12.1258L2.81684 1.55881H5.99736L11.9592 10.0867L12.8876 11.4147L20.6373 22.4998H17.4567L11.1328 13.4544V13.4538Z" fill="currentColor" /> </svg> </a> </li> <li> <a href="https://www.youtube.com/@LaravelPHP" target="_blank" title="Laravel on YouTube" class="transition duration-100 hover:text-sand-dark-6"> <svg width="35" height="24" viewBox="0 0 35 24" fill="none" xmlns="http://www.w3.org/2000/svg" > <path d="M33.892 3.75519C33.4994 2.27706 32.3428 1.11294 30.8742 0.717875C28.2124 0 17.5385 0 17.5385 0C17.5385 0 6.8648 0 4.20286 0.717875C2.7343 1.113 1.57768 2.27706 1.18511 3.75519C0.471863 6.43437 0.471863 12.0243 0.471863 12.0243C0.471863 12.0243 0.471863 17.6141 1.18511 20.2933C1.57768 21.7714 2.7343 22.8871 4.20286 23.2821C6.8648 24 17.5385 24 17.5385 24C17.5385 24 28.2123 24 30.8742 23.2821C32.3428 22.8871 33.4994 21.7714 33.892 20.2933C34.6052 17.6141 34.6052 12.0243 34.6052 12.0243C34.6052 12.0243 34.6052 6.43437 33.892 3.75519ZM14.0476 17.0994V6.94906L22.9688 12.0244L14.0476 17.0994Z" fill="currentColor" /> </svg> </a> </li> <li> <a href="https://discord.com/invite/laravel" target="_blank" title="Laravel on Discord" class="transition duration-100 hover:text-sand-dark-6"> <svg width="33" height="24" viewBox="0 0 33 24" fill="none" xmlns="http://www.w3.org/2000/svg" > <path d="M27.4296 2.00996C25.3491 1.05745 23.1528 0.381713 20.8966 0C20.5879 0.551901 20.3086 1.11973 20.0598 1.70112C17.6566 1.33898 15.2127 1.33898 12.8095 1.70112C12.5605 1.11979 12.2812 0.551968 11.9726 0C9.71504 0.384937 7.51722 1.06228 5.43462 2.01494C1.30013 8.132 0.179328 14.0971 0.739727 19.9776C3.16099 21.7665 5.87108 23.127 8.75218 24C9.40092 23.1275 9.97497 22.2018 10.4682 21.2329C9.53134 20.883 8.62706 20.4512 7.76588 19.9427C7.99253 19.7783 8.2142 19.609 8.42839 19.4446C10.9342 20.623 13.6692 21.234 16.4384 21.234C19.2075 21.234 21.9425 20.623 24.4483 19.4446C24.665 19.6214 24.8867 19.7908 25.1108 19.9427C24.248 20.4521 23.3421 20.8846 22.4035 21.2354C22.8962 22.2039 23.4702 23.1287 24.1196 24C27.0031 23.1305 29.7153 21.7707 32.137 19.9801C32.7945 13.1606 31.0137 7.25031 27.4296 2.00996ZM11.1781 16.3611C9.61644 16.3611 8.32628 14.944 8.32628 13.2005C8.32628 11.457 9.57161 10.0274 11.1731 10.0274C12.7746 10.0274 14.0548 11.457 14.0274 13.2005C14 14.944 12.7696 16.3611 11.1781 16.3611ZM21.6986 16.3611C20.1345 16.3611 18.8493 14.944 18.8493 13.2005C18.8493 11.457 20.0946 10.0274 21.6986 10.0274C23.3026 10.0274 24.5729 11.457 24.5455 13.2005C24.5181 14.944 23.2902 16.3611 21.6986 16.3611Z" fill="currentColor" /> </svg> </a> </li> </ul> <div> <ul class="flex justify-start space-x-8"> <li>© 2025 Laravel</li> <li><a href="https://laravel.com/trademark" class="transition duration-100 hover:text-sand-dark-6">Legal</a></li> <li><a href="https://status.laravel.com/" class="transition duration-100 hover:text-sand-dark-6">Status</a></li> </ul> </div> </div> <div class="grid grid-cols-subgrid col-span-12 lg:col-span-9"> <div class="grid grid-cols-subgrid mt-14 lg:mt-0 self-start lg:col-span-2 col-span-6 order-2"> <h4 class="mb-8 text-base text-sand-light-12 dark:text-sand-dark-12 font-medium lg:col-span-2 col-span-6"> Products </h4> <ul class="col-span-6 mb-6 space-y-6 lg:mb-0 lg:col-span-2"> <li> <a href="https://cloud.laravel.com" class="transition duration-100 hover:text-sand-dark-6">Cloud</a> </li> <li> <a href="https://forge.laravel.com" class="transition duration-100 hover:text-sand-dark-6">Forge</a> </li> <li> <a href="https://vapor.laravel.com" class="transition duration-100 hover:text-sand-dark-6">Vapor</a> </li> <li> <a href="https://nightwatch.laravel.com" class="transition duration-100 hover:text-sand-dark-6">Nightwatch</a> </li> <li> <a href="https://nova.laravel.com" class="transition duration-100 hover:text-sand-dark-6">Nova</a> </li> </ul> </div> <div class="grid grid-cols-subgrid mt-14 lg:mt-0 self-start lg:col-span-4 col-span-12 order-3"> <h4 class="mb-8 text-base text-sand-light-12 dark:text-sand-dark-12 font-medium lg:col-span-4 col-span-12"> Packages </h4> <ul class="col-span-6 mb-6 space-y-6 lg:mb-0 lg:col-span-2"> <li> <a href="/docs/cashier" class="transition duration-100 hover:text-sand-dark-6">Cashier</a> </li> <li> <a href="/docs/dusk" class="transition duration-100 hover:text-sand-dark-6">Dusk</a> </li> <li> <a href="/docs/horizon" class="transition duration-100 hover:text-sand-dark-6">Horizon</a> </li> <li> <a href="/docs/octane" class="transition duration-100 hover:text-sand-dark-6">Octane</a> </li> <li> <a href="/docs/scout" class="transition duration-100 hover:text-sand-dark-6">Scout</a> </li> <li> <a href="/docs/pennant" class="transition duration-100 hover:text-sand-dark-6">Pennant</a> </li> <li> <a href="/docs/pint" class="transition duration-100 hover:text-sand-dark-6">Pint</a> </li> </ul> <ul class="col-span-6 mb-6 space-y-6 lg:mb-0 lg:col-span-2"> <li> <a href="/docs/sail" class="transition duration-100 hover:text-sand-dark-6">Sail</a> </li> <li> <a href="/docs/sanctum" class="transition duration-100 hover:text-sand-dark-6">Sanctum</a> </li> <li> <a href="/docs/socialite" class="transition duration-100 hover:text-sand-dark-6">Socialite</a> </li> <li> <a href="/docs/telescope" class="transition duration-100 hover:text-sand-dark-6">Telescope</a> </li> <li> <a href="/docs/pulse" class="transition duration-100 hover:text-sand-dark-6">Pulse</a> </li> <li> <a href="/docs/reverb" class="transition duration-100 hover:text-sand-dark-6">Reverb</a> </li> <li> <a href="/docs/broadcasting" class="transition duration-100 hover:text-sand-dark-6">Echo</a> </li> </ul> </div> <div class="grid grid-cols-subgrid mt-14 lg:mt-0 self-start lg:col-span-2 col-span-6 order-1"> <h4 class="mb-8 text-base text-sand-light-12 dark:text-sand-dark-12 font-medium lg:col-span-2 col-span-6"> Resources </h4> <ul class="col-span-6 mb-6 space-y-6 lg:mb-0 lg:col-span-2"> <li> <a href="/docs" class="transition duration-100 hover:text-sand-dark-6">Documentation</a> </li> <li> <a href="/starter-kits" class="transition duration-100 hover:text-sand-dark-6">Starter Kits</a> </li> <li> <a href="/docs/releases" class="transition duration-100 hover:text-sand-dark-6">Release Notes</a> </li> <li> <a href="https://blog.laravel.com" class="transition duration-100 hover:text-sand-dark-6">Blog</a> </li> <li> <a href="https://partners.laravel.com" class="transition duration-100 hover:text-sand-dark-6">Partners</a> </li> <li> <a href="https://laravel-news.com" class="transition duration-100 hover:text-sand-dark-6">News</a> </li> <li> <a href="https://larabelles.com/" class="transition duration-100 hover:text-sand-dark-6">Larabelles</a> </li> <li> <a href="https://larajobs.com/?partner=5" class="transition duration-100 hover:text-sand-dark-6">Jobs</a> </li> <li> <a href="/careers" class="transition duration-100 hover:text-sand-dark-6">Careers</a> </li> </ul> </div> </div> <div class="col-span-12 text-sand-light-1"> <svg class="w-full h-full text-laravel-red" width="1280" height="308" viewBox="0 0 1280 308" fill="none" xmlns="http://www.w3.org/2000/svg" > <path d="M50.2753 0H0V308.689H144.713V263.27H50.2753V0Z" fill="currentColor" /> <path d="M322.209 130.973C315.796 120.684 306.688 112.602 294.883 106.718C283.081 100.84 271.201 97.8969 259.253 97.8969C243.798 97.8969 229.665 100.764 216.843 106.496C204.014 112.228 193.015 120.099 183.834 130.091C174.654 140.088 167.51 151.628 162.412 164.706C157.308 177.792 154.761 191.54 154.761 205.94C154.761 220.645 157.308 234.457 162.412 247.39C167.508 260.332 174.652 271.796 183.834 281.788C193.015 291.785 204.017 299.647 216.843 305.379C229.665 311.111 243.798 313.978 259.253 313.978C271.201 313.978 283.081 311.038 294.883 305.159C306.688 299.282 315.796 291.197 322.209 280.904V308.685H369.865V103.186H322.209V130.973ZM317.837 231.076C314.922 239.016 310.841 245.925 305.598 251.804C300.35 257.687 294.009 262.389 286.579 265.917C279.146 269.445 270.905 271.208 261.875 271.208C252.837 271.208 244.676 269.445 237.391 265.917C230.104 262.389 223.839 257.687 218.593 251.804C213.345 245.925 209.335 239.016 206.57 231.076C203.794 223.138 202.417 214.759 202.417 205.942C202.417 197.12 203.794 188.742 206.57 180.804C209.335 172.866 213.345 165.961 218.593 160.078C223.839 154.201 230.102 149.493 237.391 145.965C244.676 142.437 252.837 140.674 261.875 140.674C270.908 140.674 279.146 142.437 286.579 145.965C294.009 149.493 300.35 154.199 305.598 160.078C310.844 165.961 314.922 172.866 317.837 180.804C320.748 188.742 322.209 197.12 322.209 205.942C322.209 214.759 320.748 223.138 317.837 231.076Z" fill="currentColor" /> <path d="M709.568 130.973C703.155 120.684 694.047 112.602 682.242 106.718C670.44 100.84 658.56 97.8969 646.612 97.8969C631.157 97.8969 617.024 100.764 604.202 106.496C591.373 112.228 580.374 120.099 571.193 130.091C562.013 140.088 554.869 151.628 549.771 164.706C544.666 177.792 542.12 191.54 542.12 205.94C542.12 220.645 544.666 234.457 549.771 247.39C554.867 260.332 562.01 271.796 571.193 281.788C580.374 291.785 591.375 299.647 604.202 305.379C617.024 311.111 631.157 313.978 646.612 313.978C658.56 313.978 670.44 311.038 682.242 305.159C694.047 299.282 703.155 291.197 709.568 280.904V308.685H757.224V103.186H709.568V130.973ZM705.198 231.076C702.283 239.016 698.202 245.925 692.959 251.804C687.711 257.687 681.37 262.389 673.94 265.917C666.507 269.445 658.266 271.208 649.236 271.208C640.198 271.208 632.037 269.445 624.752 265.917C617.465 262.389 611.2 257.687 605.954 251.804C600.706 245.925 596.696 239.016 593.931 231.076C591.155 223.138 589.778 214.759 589.778 205.942C589.778 197.12 591.155 188.742 593.931 180.804C596.696 172.866 600.706 165.961 605.954 160.078C611.2 154.201 617.463 149.493 624.752 145.965C632.037 142.437 640.198 140.674 649.236 140.674C658.269 140.674 666.507 142.437 673.94 145.965C681.37 149.493 687.711 154.199 692.959 160.078C698.205 165.961 702.283 172.866 705.198 180.804C708.109 188.742 709.57 197.12 709.57 205.942C709.568 214.759 708.107 223.138 705.198 231.076Z" fill="currentColor" /> <path d="M1280 1.12315e-05H1232.35V308.689H1280V1.12315e-05Z" fill="currentColor" /> <path d="M407.466 308.689H455.117V150.486H536.876V103.192H407.466V308.689Z" fill="currentColor" /> <path d="M948.281 103.192L888.386 260.557L828.489 103.192H780.224L858.441 308.689H918.331L996.546 103.192H948.281Z" fill="currentColor" /> <path d="M1100.48 97.908C1042.13 97.908 995.937 146.279 995.937 205.944C995.937 271.9 1040.64 313.98 1106.59 313.98C1143.5 313.98 1167.06 299.745 1195.85 268.746L1163.66 243.621C1163.64 243.646 1139.36 275.802 1103.1 275.802C1060.96 275.802 1043.22 241.533 1043.22 223.803H1201.32C1209.62 155.913 1165.37 97.908 1100.48 97.908ZM1043.35 188.085C1043.71 184.13 1049.2 136.086 1100.1 136.086C1151.01 136.086 1157.19 184.123 1157.55 188.085H1043.35Z" fill="currentColor" /> </svg> </div> </div> </div> </div> <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> </body> </html>