Use multiple
.envs
files and have a chain of precedence for the environment variables in these different.envs
files. Use the.env
file in a custom way to manipulate environment variables by domain (multi-tenant).
The package has been developed and tested to work with the following minimum requirements:
- PHP 8.0
- Laravel 9.0
Laravel | PHP | Package |
---|---|---|
9.x | 8.0 | ^2.0 |
8.x | 7.4 | ^1.0 |
You can install the package via Composer:
composer require allysonsilva/laravel-multienv
You can then publish the package's config file by using the following command:
php artisan vendor:publish --tag="envs-config"
-
Add trait to kernel console
app/Console/Kernel.php
:<?php namespace App\Console; use Illuminate\Console\Scheduling\Schedule; +use Allyson\MultiEnv\Concerns\ConsoleCallTrait; +use Allyson\MultiEnv\Concerns\BootstrappersTrait; use Illuminate\Foundation\Console\Kernel as ConsoleKernel; class Kernel extends ConsoleKernel { + use BootstrappersTrait, ConsoleCallTrait;
-
Add trait to kernel http
app/Http/Kernel.php
:<?php namespace App\Http; +use Allyson\MultiEnv\Concerns\BootstrappersTrait; use Illuminate\Foundation\Http\Kernel as HttpKernel; class Kernel extends HttpKernel { + use BootstrappersTrait;
The use of this package happens by manipulating the
.envs
files in the project.
-
You can use as many
.env
files as you like. -
By default, when listing
.env
files to give priority to the last ones, the "natural order" algorithm is used, more specifically PHP'sstrnatcmp
function, thus the environment variables of the last.envs
will have priority / precedence over all others.- You can use the
config('envs.sorted')
to custom sort the.envs
files. The last items in the array will have priority over the others.
- You can use the
-
Use the
config('envs.ignored')
regex to ignore.env
files that should not be processed/handled.
Assuming we have 3 .env
files in the root of the application with their environment variables as follows:
.
โโโ app
โโโ bootstrap
โโโ config
โโโ database
โโโ envs
โย ย โโโ .env.site1.test
โย ย โโโ .env.site2.test
โโโ lang
โโโ public
โโโ resources
โโโ routes
โโโ storage
โโโ tests
โโโ .env
โโโ .env.example
+โโโ .envA
+โโโ .envB
+โโโ .envC
โโโ .gitattributes
โโโ .gitignore
โโโ README.md
โโโ artisan
โโโ composer.json
โโโ phpunit.xml
Obs: The envs
folder in the application structure below will be explained later.
Each .env
file has its environment variables set as follows:
.envA
:
ENV_NAME="NAME Env A"
APP_URL=http://env-a.test
ENV_FILE_A=.envA
.envB
:
ENV_NAME="NAME Env B"
APP_URL=http://env-b.test
ENV_FILE_B=.envB
.envC
:
ENV_NAME="NAME Env C"
APP_URL=http://env-c.test
ENV_FILE_C=.envC
As it is, the .envC
file is the last one listed in the structure above, so it will override any environment variables defined in the preceding .env
files, and the environment variables that exist in the other files. more is not in the last (priority), it will continue to be used normally, the result / consolidated of the environment variables of the three files are:
ENV_NAME="NAME Env C"
APP_URL=http://env-c.test
ENV_FILE_A=.envA
ENV_FILE_B=.envB
ENV_FILE_C=.envC
Using the configuration of config('envs.sorted')
, you can customize the default order of file priorities:
'sorted' => [
'.envA',
'.envC',
'.envB',
],
As above, the result of the environment variables of the 3 files would be:
ENV_NAME="NAME Env B"
APP_URL=http://env-b.test
ENV_FILE_A=.envA
ENV_FILE_C=.envC
ENV_FILE_B=.envB
In the same way that you use multiple envs files in the root of the application, it is possible to use .env
files per domain:
-
These files are located in the configuration folder of
config('envs.folder')
, which by default the folder name isenvs
, as seen in the project listing above. -
In order for the
.env
file to match the domain / subdomain, it must be created as follows:.env.<domain>
. -
To configure a different
.env
filename than the default, add the domain toconfig('envs.domains')
, having theenv
key of the domain set to your preference.
Using the same structure as the previous example, if the request / domain is site1.test
, and there is a file .env.site1.test
inside the envs
folder, then the environment variables in that file will override all the other environment variables.
Assuming that the .env.site1.test
file has the following variables:
ENV_NAME="NAME Env SITE 1"
APP_URL=http://site1.test
When environment variables are used in the project, they will have the following results:
ENV_NAME="NAME Env SITE 1"
APP_URL=http://site1.test
ENV_FILE_A=.envA
ENV_FILE_C=.envC
ENV_FILE_B=.envB
To see the examples in action, let's use this laravel application.
When the domain's .env
filename is different from the default which is: .env.<domain>
, then set the env
key in the domain configs in config('envs.domains')
, as follows:
'domains' => [
'your-domain.tld' => [
'env' => '.env.custom-name',
],
],
You can cache configs and routes by domain.
A new --domain
option is available in the command. Using this option, the environment variables from the domain's .env
file in the envs
folder will override and take precedence over all others.
Use the config('envs.domains')
configuration to customize the .php
file that will be saved and used as a cache of configs. This ensures that multiple configuration files per domain can exist and be used in the same project.
To generate and use the .php
file with a custom name of the domain cache settings, use the following code as an example:
'domains' => [
'site2.test' => [
'APP_CONFIG_CACHE' => 'config-site2-test.php',
],
],
As in the section above, the command to create the route cache file has a new --domain
option, which will be used to filter only the routes that have the domain according to the option value.
It is also possible to have a custom name for the routes cache file, such as the configuration cache, is through the APP_ROUTES_CACHE
key, as in the example below:
'domains' => [
'site2.test' => [
'APP_ROUTES_CACHE' => 'routes-v7-site2-test.php',
],
],
composer test:unit
Please see CHANGELOG for more information about the changes on this package.
Please see CONTRIBUTING for details.
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
The MIT License (MIT). Please see License File for more information.