startap/sail-podman

Podman compatibility layer to @laravel/sail application.

1.0.2 2024-04-16 00:28 UTC

Requires

• php: ^8.0
• illuminate/console: ^9.52.16|^10.0|^11.0
• illuminate/contracts: ^9.52.16|^10.0|^11.0
• illuminate/support: ^9.52.16|^10.0|^11.0
• symfony/console: ^6.0|^7.0
• symfony/yaml: ^6.0|^7.0

Requires (Dev)

• orchestra/testbench: ^7.0|^8.0|^9.0
• phpstan/phpstan: ^1.10

Replaces

• laravel/sail: 1.29.1

MIT

• André Paul Grandsire

• laravel
• docker
• sail
• podman

README

This is just a simple fork from Laravel Sail project, aimed to provide compatibility with Podman and Podman Composer. All we did was tweak some binaries to be able to recognize Podman instead of Docker when running Sail. All the rest of source code was left untouched for now.

🛡️ Can I rely on this package? Why not Sail?

Well, Sail it's very good. But they do not have plans to support Podman (see #83 and this comment from #198). We already use Podman and made a change locally on Sail binary, inside vendor folder.

That change got away with every new Sail update. So, to keep in track with Sail upstream changes and provide a compatibility layer with Podman, we create this package and change a few things in bin/sail file to be able to recnognize Podman/Podman Compose as executable.

For now, these changes are hardcoded, but we can improve it later.

🤔 What's Laravel Sail?

Sail provides a Docker powered local development experience for Laravel that is compatible with macOS, Windows (WSL2), and Linux. Other than Docker, no software or libraries are required to be installed on your local computer before using Sail. Sail's simple CLI means you can start building your Laravel application without any previous Docker experience.

📜 You can read more about it on laravel.com/docs/sail or Laravel Sail GitHub repository.

📦 How to install?

You can use this package right from Packagist repository with Composer.

composer require startap/sail-podman

⚠️ Compatibility note

Don't forget: if you already have Laravel Sail installed, it's required that you remove it first. You can do it with Composer too:

composer remove laravel/sail

🎯 Roadmap

We want to make this project active and maintaned. So a few future improvements are planned, and you can follow it's implementation here:

• Change binary name from Sail to SailPod, to fix compatiblity issues with Laravel/Sail installations
• Think a way to encapsulate Sail package to avoid conflicts with upstream Sail

If you want to contribute, suggest a feature to our roadmap or report a bug, be welcome. It's all in this repository: issues, discussions and pull requests.