2.0.0 2021-06-09 03:15 UTC

This package is auto-updated.

Last update: 2024-04-09 10:36:26 UTC




$ composer require jimchen/hyperf-sail -vvv



After Sail has been installed, you may run the sail:install command. This command will publish Sail's docker-compose.yml file to the root of your application:

$ php bin/hyperf.php sail:install

Finally, you may start Sail. To continue learning how to use Sail, please continue reading the remainder of this documentation:

$ ./vendor/bin/sail up

However, instead of repeatedly typing vendor/bin/sail to execute Sail commands, you may wish to configure a Bash alias that allows you to execute Sail's commands more easily:

$ alias sail='bash vendor/bin/sail'

Once the Bash alias has been configured, you may execute Sail commands by simply typing sail. The remainder of this documentation's examples will assume that you have configured this alias:

$ sail up

Starting & Stopping Sail

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 docker-compose.yml file, you should execute the up command:

$ sail up

To start all of the Docker containers in the background, you may start Sail in "detached" mode:

$ sail up -d

Once the application's containers have been started, you may access the project in your web browser at: http://localhost:9501.

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 down command:

$ sail down


You can contribute in one of three ways:

  1. File bug reports using the issue tracker.
  2. Answer questions or fix bugs on the issue tracker.
  3. Contribute new features or update the wiki.

The code contribution process is not very formal. You just need to make sure that you follow the PSR-0, PSR-1, and PSR-2 coding guidelines. Any new code contributions must be accompanied by unit tests where applicable.