PHPackages reedware/sail-lite - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [DevOps & Deployment](/categories/devops) 4. / 5. reedware/sail-lite ActiveLibrary[DevOps & Deployment](/categories/devops) reedware/sail-lite ================== Docker files for basic PHP package development v2.0.1(2mo ago)17.6k↓76.6%3MITShellCI failing Since Apr 7Pushed 2mo ago1 watchersCompare [ Source](https://github.com/tylernathanreed/sail-lite)[ Packagist](https://packagist.org/packages/reedware/sail-lite)[ RSS](/packages/reedware-sail-lite/feed)WikiDiscussions master Synced 3d ago READMEChangelog (7)DependenciesVersions (9)Used By (3) Sail Lite ========= [](#sail-lite) [![PHP](https://camo.githubusercontent.com/fec879bac2adfaade2311e9e7294e9adcf469d4c80c641f2e3ab5dfc9ebbeae7/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f5048502d372e322d2d382e352d626c7565)](https://www.php.net/)[![Latest Stable Version](https://camo.githubusercontent.com/4ba022bf6f2d259823c3f0ef9cc3f5dbca435fb2d8f78400a73cad3bb9c25e3d/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f72656564776172652f7361696c2d6c697465)](https://packagist.org/packages/reedware/sail-lite)[![License](https://camo.githubusercontent.com/76adc66cd4d66a501515391a4650e68698b992ac2ad9e5fb1c2baddcd0215b1e/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f6c2f72656564776172652f7361696c2d6c697465)](https://packagist.org/packages/reedware/sail-lite) Table of Contents ----------------- [](#table-of-contents) - [Introduction](#introduction) - [Sail Lite vs Docker Compose](#sail-lite-vs-docker-compose) - [Sail Lite vs Laravel Sail](#sail-lite-vs-laravel-sail) - [Installation and Setup](#installation-and-setup) - [Installing into Existing PHP Environments](#installing-into-existing-php-environments) - [Installing into New PHP Environments](#installing-into-new-php-environments) - [Configuring a Shell Alias](#configuring-a-shell-alias) - [Rebuilding Images](#rebuilding-images) - [Starting and Stopping](#starting-and-stopping) - [Executing Commands](#executing-commands) - [PHP Versions](#php-versions) - [Customization](#customization) Introduction ------------ [](#introduction) Sail Lite is a light-weight command-line interface for interacting a baseline [Docker](https://www.docker.com/) environment for package development. Sail Lite was inspired by [Laravel Sail](https://github.com/laravel/sail), which offers a richer experience for Laravel development. Sail Lite is intended to be a lighter-weight alternative to Laravel Sail, targeting package development, and isn't specific to Laravel development. At its heart, Sail Lite is the `docker-compose.yml` file and the `sail` script that is stored at the root of your project. The `sail` script provides a CLI with convenient methods for interacting with the Docker containers defined by the `docker-compose.yml` file. Sail Lite is supported on macOS, Linux, and Windows (via [WSL2](https://docs.microsoft.com/en-us/windows/wsl/about)). Sail Lite vs Docker Compose --------------------------- [](#sail-lite-vs-docker-compose) Under the hood, Sail Lite is just [Docker](https://www.docker.com/). However, Sail Lite is pre-configured for PHP package development, and offers a `sail` binary with commands that are easier to work with. Sail LiteDocker Compose`sail up``docker compose up``sail down``docker compose down``sail build``docker compose build``sail bash``docker compose exec -u sail dev bash`Sail Lite vs Laravel Sail ------------------------- [](#sail-lite-vs-laravel-sail) Sail Lite is intended for PHP package development, where as Laravel Sail targets the general Laravel developer experience. If you intend to build Laravel applications, you should use Laravel Sail. Sail Lite installs far fewer container dependencies than Laravel Sail (35 and counting), in that there's no database, cache, or node.js support. Laravel Sail also requires several Illuminate and Symfony libraries, whereas Sail Lite has no package dependencies. Sail LiteLaravel Sail[![Sail Lite Vendor](/img/sail-lite-vendor.png)](/img/sail-lite-vendor.png)[![Laravel Sail Vendor](/img/laravel-sail-vendor.png)](/img/laravel-sail-vendor.png)Installation and Setup ---------------------- [](#installation-and-setup) ### Installing into Existing PHP Environments [](#installing-into-existing-php-environments) If you are interested in using Sail Lite with an existing PHP package, you may simply install Sail Lite using the Composer package manager. Of course, these steps assume that your existing local development environment allows you to install Composer dependencies: ``` composer require reedware/sail-lite --dev ``` After Sail Lite has been installed, you may run the install command. This command will publish the `docker-compose.yml` file to the root of your application. ``` ./vendor/bin/sail install ``` Finally, you may start Sail Lite. ### Installing into New PHP Environments [](#installing-into-new-php-environments) If you don't want to install PHP or Composer locally, you can install the `sail` binary and install your Composer dependencies from inside the new container: ``` mkdir -p vendor/bin wget -O vendor/bin/sail https://raw.githubusercontent.com/tylernathanreed/sail-lite/refs/heads/master/bin/sail chmod +x vendor/bin/sail ./vendor/bin/sail build ./vendor/bin/sail up -d ./vendor/bin/sail bash > composer require reedware/sail-lite --dev > exit ./vendor/bin/sail install ``` ### Configuring a Shell Alias [](#configuring-a-shell-alias) By default, Sail Lite commands are invoked using the `vendor/bin/sail` script: ``` ./vendor/bin/sail up -d ``` However, instead of repeatedly typing `vendor/bin/sail` to execute Sail Lite commands, you may wish to configure a shell alias that allows you to execute Sail's commands more easily: ``` alias sail='$([ -f sail ] && echo sail || echo vendor/bin/sail)' ``` To make sure this is always available, you may add this to your shell configuration file in your home directory, such as `~/.zshrc` or `~/.bashrc`, and then restart your shell. Once the shell alias has been configured, you may execute Sail Lite commands by simply typing `sail`. The remainder of this documentation's examples will assume that you have configured this alias: ``` sail up -d ``` ### Rebuilding Images [](#rebuilding-images) Sometimes you may want to completely rebuild your Sail Lite images to ensure all of the image's packages and software are up to date. You may accomplish this using the `build` command: ``` sail down sail build --no-cache sail up ``` Starting and Stopping --------------------- [](#starting-and-stopping) Sail Lite's `docker-compose.yml` file defines a single development container to help you build PHP packages. To start the development container, you should execute the up command: ``` sail up ``` To start the development container in the background, you may start Sail Lite in "detached" mode: ``` sail up -d ``` To stop the development container, you may simply press Control + C to stop the container's execution. Or, if the container is running in the background, you may use the stop command: ``` sail stop ``` Executing Commands ------------------ [](#executing-commands) When using Site Lite, you package is executing within a Docker container, and is isolated from your local computer. You may use the `shell` command to connect to your development container, allowing you to execute arbitrary shell commands within the container. ``` sail shell sail root-shell ``` PHP Versions ------------ [](#php-versions) By default, Sail Lite uses the latest version of PHP. However, this can be changed in your `docker-compose.yml` file: ``` services: dev: image: sail-lite/basic build: context: ./vendor/reedware/sail-lite/runtimes/basic dockerfile: Dockerfile args: PHP: '${PHP_VERSION:-8.5}' #