Configuring Laravel With Additional Environment Files

Last updated on by

Configuring Laravel With Additional Environment Files image

In Laravel, you can configure additional environment files that will load instead of the .env file. This feature is helpful for testing, where you can load a .env.testing environment file instead of the default. You typically don't need to reach for this feature, but it's nice to know that by setting the APP_ENV environment variable, Laravel can detect custom configurations.

CLI Example

The most straightforward example of this feature is using a different environment file when running Laravel with the Artisan console or even the phpunit CLI.

Using the Artisan command, you can also use a different .env file using the --env flag or defining an APP_ENV. For example, running the following, Laravel will look for .env.demo:

# Set up `.env.demo`
cp .env .env.demo
echo "\nEXAMPLE_SETTING=demo" >> .env.demo
 
# Use the `demo` env
 
php artisan tinker --env=demo
 
# Or set APP_ENV
APP_ENV=demo php artisan tinker

If found, Laravel won't load the .env file but instead load .env.demo:

Example using .env.demo instead of .env
Example using .env.demo instead of .env

Using .env.testing for PHPUnit Tests

Building on what we know about the Laravel framework loading a specific ENV file if it exists, running Laravel feature tests in PHPUnit will use the .env file by default. Using .env for tests and local development could quickly cause issues such as configuring a separate database for testing. You could define database connection details in phpunit.xml, but let's also look at setting them in .env.testing.

PHPUnit defines an APP_ENV environment variable in phpunit.xml, which means that Laravel looks for a .env.testing file when bootstrapping Feature tests because the phpunit.xml file defines APP_ENV before the Laravel framework gets bootstrapped in Feature tests:

<env name="APP_ENV" value="testing"/>

That means we can copy the stock .env file to .env.testing and avoid mixing the two files during testing:

cp .env .env.testing
 
echo "\nEXAMPLE_SETTING=testing" >> .env.testing

You can configure environment variables in phpunit.xml. However, I like using the .env.testing file to ensure a clean environment specifically for testing. It's also up to you whether you version control .env.testing or ignore it in .gitignore.

After copying the .env file, you can verify that .env.testing is loaded by adding the following to a test in your tests/Feature folder. Tests in the tests/Unit folder won't bootstrap the Laravel framework:

/**
* A basic test example.
*/
public function test_the_application_returns_a_successful_response(): void
{
logger('Which environment file is Laravel using?', [
'file' => $this->app->environmentFile()
]);
 
$response = $this->get('/');
 
$response->assertStatus(200);
}

When I run phpunit, I get the following log confirming that I'm using the .env.testing file:

[2024-05-24 00:22:42] testing.DEBUG: Which environment file is Laravel using? {"file":".env.testing"}

If you ignore this file in your VCS, you could add an example file .env.testing.example with your team's conventions or let them decide how to configure tests locally. I recommend setting system-level environment variables in CI to configure things like test databases.

Check out the Laravel Documentation for more details on environment configuration. If you're curious how this works at the framework level, check out the setEnvironmentFilePath method and checkForSpecificEnvironmentFile in the Laravel framework source code.

Paul Redmond photo

Staff writer at Laravel News. Full stack web developer and author.

Cube

Laravel Newsletter

Join 40k+ other developers and never miss out on new tips, tutorials, and more.

image
Laravel Forge

Easily create and manage your servers and deploy your Laravel applications in seconds.

Visit Laravel Forge
Laravel Forge logo

Laravel Forge

Easily create and manage your servers and deploy your Laravel applications in seconds.

Laravel Forge
Tinkerwell logo

Tinkerwell

The must-have code runner for Laravel developers. Tinker with AI, autocompletion and instant feedback on local and production environments.

Tinkerwell
No Compromises logo

No Compromises

Joel and Aaron, the two seasoned devs from the No Compromises podcast, are now available to hire for your Laravel project. ⬧ Flat rate of $7500/mo. ⬧ No lengthy sales process. ⬧ No contracts. ⬧ 100% money back guarantee.

No Compromises
Kirschbaum logo

Kirschbaum

Providing innovation and stability to ensure your web application succeeds.

Kirschbaum
Shift logo

Shift

Running an old Laravel version? Instant, automated Laravel upgrades and code modernization to keep your applications fresh.

Shift
Bacancy logo

Bacancy

Supercharge your project with a seasoned Laravel developer with 4-6 years of experience for just $2500/month. Get 160 hours of dedicated expertise & a risk-free 15-day trial. Schedule a call now!

Bacancy
Lucky Media logo

Lucky Media

Bespoke software solutions built for your business. We ♥ Laravel

Lucky Media
Lunar: Laravel E-Commerce logo

Lunar: Laravel E-Commerce

E-Commerce for Laravel. An open-source package that brings the power of modern headless e-commerce functionality to Laravel.

Lunar: Laravel E-Commerce
LaraJobs logo

LaraJobs

The official Laravel job board

LaraJobs
Larafast: Laravel SaaS Starter Kit logo

Larafast: Laravel SaaS Starter Kit

Larafast is a Laravel SaaS Starter Kit with ready-to-go features for Payments, Auth, Admin, Blog, SEO, and beautiful themes. Available with Vue and Livewire stacks.

Larafast: Laravel SaaS Starter Kit
SaaSykit: Laravel SaaS Starter Kit logo

SaaSykit: Laravel SaaS Starter Kit

SaaSykit is a Laravel SaaS Starter Kit that comes with all features required to run a modern SaaS. Payments, Beautiful Checkout, Admin Panel, User dashboard, Auth, Ready Components, Stats, Blog, Docs and more.

SaaSykit: Laravel SaaS Starter Kit
Rector logo

Rector

Your partner for seamless Laravel upgrades, cutting costs, and accelerating innovation for successful companies

Rector

The latest

View all →
Create a DateTime from a Timestamp With this New Method Coming to PHP 8.4 image

Create a DateTime from a Timestamp With this New Method Coming to PHP 8.4

Read article
Neovim Plugin to for Navigating Laravel and Livewire Components image

Neovim Plugin to for Navigating Laravel and Livewire Components

Read article
Laravel Herd v1.7 is out with updates to the dump UI image

Laravel Herd v1.7 is out with updates to the dump UI

Read article
Share Error Package for Laravel's New Exception Page image

Share Error Package for Laravel's New Exception Page

Read article
Sentry and Laravel announce a new partnership image

Sentry and Laravel announce a new partnership

Read article
"Fast Projects" by Larafast: Real life, ready to use Laravel based Boilerplates image

"Fast Projects" by Larafast: Real life, ready to use Laravel based Boilerplates

Read article