[6.1] Variables from non natural environment

[Fedik]

Pull Request for Issue #36898 .

Alternative to PR #45070 .

Summary of Changes

This is complete (I hope) implementation of environment variables in Joomla.

Key points:

• By default the feature is disabled. Create .env in root folder to enable it (can be just an empty file).
• I tried to keep the variable names in sync with Joomla Docker. If you find something is missing or a typo, please let me know.
• The installation can be completed with environment variables (except language part). This work with CLI and WEB installer. User can provide all options via environment variables (including admin user info) or a few (like DB only, then installer will ask for missing options).
• The configuration options provided by environment variables cannot be edited in backend, also via CLI.

Testing Instructions

Test installation, test with Web and in CLI installer

1. Create .env with DB options:

JOOMLA_DB_TYPE="mysql"
JOOMLA_DB_HOST="Your DB host"
JOOMLA_DB_USER="Your DB user"
JOOMLA_DB_PASSWORD="Your DB password"
JOOMLA_DB_NAME="Your db name"
JOOMLA_DB_PREFIX="DB prefix"

And run installer. You should be asked for Site name, and User information.
Then installation should be completed, as usual.

2. Create .env with all installation parameters and user information:

JOOMLA_DB_TYPE="mysql"
JOOMLA_DB_HOST="Your DB host"
JOOMLA_DB_USER="Your DB user"
JOOMLA_DB_PASSWORD="Your DB password"
JOOMLA_DB_NAME="Your db name"
JOOMLA_DB_PREFIX="DB prefix"

JOOMLA_SITE_NAME="Test installation"
JOOMLA_PUBLIC_FOLDER=""

JOOMLA_ADMIN_USER="Your admin user"
JOOMLA_ADMIN_USERNAME="Your admin username"
JOOMLA_ADMIN_PASSWORD="Your admin user password"
JOOMLA_ADMIN_EMAIL="Your admin user email"

And run installer. You will not be asked for Site name, and User information.
The installation should be completed, as usual.

Test the existing site

Create .env with DB options, and copy options from configuration.php.
(skip this step if the site was installed with use of .env)

JOOMLA_DB_TYPE="mysql"
JOOMLA_DB_HOST="Your DB host"
JOOMLA_DB_USER="Your DB user"
JOOMLA_DB_PASSWORD="Your DB password"
JOOMLA_DB_NAME="Your db name"
JOOMLA_DB_PREFIX="DB prefix"

Then visit the site, all should work as before.

Link to documentations

Please select:

• Documentation link for docs.joomla.org:
• No documentation changes for docs.joomla.org needed
• Pull Request link for manual.joomla.org: TBD
• No documentation changes for manual.joomla.org needed

@Llewellynvdm please have a look if it will be good with Joomla Docker, thanks!

[dautrich]

@Fedik I get the same issue with a Nightly Build of 6.0. Therefore, the issue seems to be related to my Laragon environment. Unfortunately, I don't have on online test site at hand at the moment.

[Fedik]

@dautrich no problem, thank you for checking

[brianteeman]

fyi my tests were with laragon 8

[dautrich]

fyi I use Laragon 6

[dautrich]

I have tested this item ✅ successfully on ce36cf3

---

_{This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/45523.}

[richard67]

RTC

---

_{This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/45523.}

[brianteeman]

@dautrich what changed to make it work?

[dautrich]

@brianteeman
I tested the CLI part on the Internet (not locally via Laragon). The resulting site is still online under upgrade.hasenritter.de

[brianteeman]

Ok. Must have been a local config issue with your laragon 6 instance

[richard67]

I've allowed myself to fix the conflict in the composer.lock file by updating the content hash with composer update --lock.

[HLeithner]

This pull request has been automatically rebased to 6.1-dev.

[tecpromotion]

@Fedik We would like to have this in 6.1. Can you please resolve the conflict? Thank you very much.

[HLeithner]

I talked to @SniperSister and we would like to request some changes:

• checking for an JOOMLA_ENVIRONMENT environment variable
• instead check that a .env file exists (always even if it's empty) to use $_ENV
• and .env file is not in JPATH_PUBLIC

This increases the security by using the public folder feature and allow to make people more aware of it.
Also it makes it "impossible" to extract any .env.* file per direct browser request

Another thing I would like to request is to follow the .env naming semantic used by symfony and mentioned by @voronkovich in this comment
and in this comment

would be great if you can update the pr so we can get it ready for 6.1

[Fedik]

JOOMLA_ENVIRONMENT already there.
Also with it we no need naming semantic because target file can be set with this variable.

[Fedik]

It is need some more review of the feature. I set it to draft for now.

[Fedik]

I made alternative version which supports environment variables in PHP file.

• [6.1] Variables from non natural environment v2 #46665