maximgubar/platformsh-symfonyflex-bridge

Bridge library for running Symfony Flex on Platform.sh

Maintainers

Details

github.com/maximgubar/symfonyflex-bridge

Source

Installs: 4 989

Dependents: 0

Suggesters: 0

Security: 0

Stars: 1

Watchers: 1

Forks: 15

4.0.0 2021-06-14 08:06 UTC

Requires

Requires (Dev)

MIT 7d9722a39b8dcf6efad88de88f89d24ef5c6a1cd

  • Larry Garfield <larry.woop@platform.sh>

This package is auto-updated.

Last update: 2024-11-14 15:42:19 UTC

README

CircleCI Status

This simple bridge library connects a Symfony Flex-based application to Platform.sh. In the typical case it should be completely fire-and-forget.

Symfony Flex expects 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 Symfony Flex 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 Symfony bootstraps its configuration (which it almost certainly will) everything should work fine with no further user-interaction necessary.

composer require platformsh/symfonyflex-bridge

Mappings performed

  • If a Platform.sh relationship named database is defined, it will be taken as an SQL database and mapped to the DATABASE_URL environment variable for Symfony Flex. (Note: Due to a bug in Doctrine, the code currently assumes MariaDB 10.2 as the service version. If that Doctrine bug is ever resolved this hard-coding can be removed.)

  • If a Platform.sh relationship named mongodatabase is defined, it will be taken as a Doctrine ODM database and mapped to the appropriate environment variables. Note that you may still need to reference those environment variables in your configuration if they are not defined by default. See the DoctrineMongoDBBundle documentation for more details.

  • The Symfony Flex APP_SECRET is set based on the PLATFORM_PROJECT_ENTROPY variable, which is provided for exactly this purpose.

  • The MAILER_URL variable is set based on the PLATFORM_SMTP_HOST variable. That will be used by SwiftMailer if it is installed. If not installed this value will be safely ignored.

  • If no APP_ENV value is set, it will default to prod.