Skip to content

Update env-support.md: .env.php only accepts # for comments #964

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Mar 26, 2025
Merged

Update env-support.md: .env.php only accepts # for comments #964

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
51131cd
Update env-support.md
jaredchesebro Mar 21, 2025
08b8a32
Update comment formatting in code block to avoid issues with markdown…
bryannielsen Mar 26, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 11 additions & 10 deletions docs/advanced-usage/env-support.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
-->
# ENV File Support

Config files can also be configured using [PHP Environment variables ($_ENV)](https://www.php.net/manual/en/reserved.variables.environment.php). To utilize this, create a file named `.env.php` in the root of your ExpressionEngine install.
Config files can also be configured using [PHP Environment variables ($_ENV)](https://www.php.net/manual/en/reserved.variables.environment.php). To utilize this, create a file named `.env.php` in the root of your ExpressionEngine install.

NOTE: The `.env.php` file must be placed in same directory as the `system` directory. If you move the `system` directory above the webroot you must also move `.env.php`.

Expand All @@ -31,19 +31,20 @@ This variable can now be used in your `/system/user/config.php` as illustrated b
Here is an example of what it might look like to manage all your database connection settings, and Base URL in `.env.php`

```
// .env.php

// URLs
#.env.php
#URLs
BASE_URL=http://mysite.test/

// DATABASE SETTINGS
#DATABASE SETTINGS
DB_HOSTNAME=db
DB_DATABASE=db
DB_USERNAME=db
DB_PASSWORD=db
DB_PORT=3306
```

NOTE: You must use `#` for comments within `.env.php`. Using `//` will result in your `.env.php` being unable to be read.

```
// system/user/config.php
<?php if ( ! defined('BASEPATH')) exit('No direct script access allowed');
Expand All @@ -53,7 +54,7 @@ $config['save_tmpl_files'] = 'y';
$config['base_url'] = $_ENV['BASE_URL'];
$config['site_url'] = $config['base_url'];

$config['app_version'] = '7.2.0';
$config['app_version'] = '7.5.8';
$config['encryption_key'] = 'bb748b72de235352315122d00';
$config['session_crypt_key'] = '985796e4444444563463e2c80242';

Expand Down Expand Up @@ -83,15 +84,15 @@ The site short name can be accessed in the code using `$GLOBALS['assign_to_confi
The below example demonstrates this approach, assuming you have 2 MSM sites with short names of `default_site` and `second_site`

```
// .env.php
// SITE-SPECIFIC SETTINGS
#.env.php
#SITE-SPECIFIC SETTINGS
default_site.BASE_PATH=/home/sites/mysite.test/
default_site.BASE_URL=http://mysite.test/

second_site.BASE_PATH=/home/sites/anothersite.test/
second_site.BASE_URL=http://anothersite.test/

// DATABASE SETTINGS
#DATABASE SETTINGS
DB_HOSTNAME=db
DB_DATABASE=db
DB_USERNAME=db
Expand All @@ -110,7 +111,7 @@ $config['base_url'] = $_ENV[$GLOBALS['assign_to_config']['site_name'] . '.' . 'B

$config['site_url'] = $config['base_url'];

$config['app_version'] = '7.2.0';
$config['app_version'] = '7.5.8';
$config['encryption_key'] = 'bb748b72de235352315122d00';
$config['session_crypt_key'] = '985796e4444444563463e2c80242';

Expand Down