platformsh / laravel-bridge
Bridge library for running Symfony Flex on Platform.sh
Installs: 189 525
Dependents: 0
Suggesters: 0
Security: 0
Stars: 8
Watchers: 16
Forks: 16
Open Issues: 4
Requires
- php: >=7.2
- platformsh/config-reader: ^2.4.0
Requires (Dev)
- phpunit/phpunit: ^8.5
README
This simple bridge library connects a Laravel-based application to Platform.sh. In the typical case it should be completely fire-and-forget.
Laravel prefers all configuration to come in through environment variables with specific names in a specific format. Platform.sh provides configuration information as environment variables in a different specific format. This library handles mapping the Platform.sh variables to the format Laravel expects for common values.
Usage
Simply require this package using Composer. When Composer's autoload is included this library will be activated and the environment variables set. As long as that happens before Laravel bootstraps its configuration (which it almost certainly will) everything should work fine with no further user-interaction necessary.
composer require platformsh/laravel-bridge
Note make sure to clear the cache on relevant platform.sh environments after updating this package.
php artisan cache:clear
Mappings performed
-
If a Platform.sh relationship named
database
is defined, it will be taken as an SQL database and mapped to theDB_*
environment variables for Laravel. -
If a Platform.sh relationship named
rediscache
is defined, it will be mapped to theREDIS_*
environment variables for Laravel. Additionally, theCACHE_DRIVER
(up to Laravel v10) andCACHE_STORE
(Laravel v11+) variables will be set toredis
to activate it automatically. -
If a Platform.sh relationship named
redissession
is defined, theSESSION_DRIVER
will be set toredis
and theREDIS_*
variables set based on that relationship. NOTE: This means you must set 2 relationships to the same Redis service and endpoint, as Laravel reuses the same backend connection. -
The Laravel
APP_KEY
is set based on thePLATFORM_PROJECT_ENTROPY
variable, which is provided for exactly this purpose. -
The Laravel
APP_URL
variable is set based on the current route if possible. -
The
SESSION_SECURE_COOKIE
variable is set to true if it's not already defined. A Platform.sh environment is by default encrypted-always, so there's no reason to allow unencrypted cookies. This can be overridden by setting the Platform.sh variableenv:SESSION_SECURE_COOKIE
to 0. -
The
MAIL_DRIVER
,MAIL_HOST
, andMAIL_PORT
variables are set to support sending email through the Platform.sh mail gateway. TheMAIL_ENCRYPTION
value is also set to0
to disable TLS, as it is not needed or supported within Platform.sh's network. Note, however, that doing so is only supported on Laravel 6.0.4 and later. On earlier versions you must manually modifymail.php
and setencryption
tonull
:
'encryption' => null,
Common environment variables not set
Laravel provides reasonable defaults for many environment variables already and this library does not override those. They may, however, be customized by setting a Platform.sh variable named env:ENV_NAME
. (Note the env:
prefix.) The most likely variables to override are listed below for convenience:
env:APP_NAME
: The human-friendly name of the application.env:APP_ENV
: Whether the application is inproduction
ordevelopment
mode.env:APP_DEBUG
: Set true to enable verbose error messages.