[6.0] Configure Joomla with environment variables #44894

voronkovich · 2025-02-13T15:53:24Z

Pull Request for Issue #36898.

Summary of Changes

This PR adds an ability to configure Joomla using environment variables. To do this, the config provider has been changed to load all environment variables whose names start with JOOMLA_ (e.g. JOOMLA_DEBUG, JOOMLA_PASSWORD) and merge them into the config service.

Also, environment variables can be loaded from .env files, thankfully to symfony/dotenv.

Testing Instructions

Create .env file in the site's root directory

Set environment variables (inside the .env file):

JOOMLA_OFFLINE=1
JOOMLA_OFFLINE_MESSAGE='Joomla!'

Reload site's home page and ensure that site is offline and the Joomla! message is shown
Run the following command and ensure that the output is true:
```
cli/joomla.php config:get offline
```
Run the following command and ensure that the output is Joomla!:
```
cli/joomla.php config:get offline_message
```

Actual result BEFORE applying this Pull Request

All should work.

Expected result AFTER applying this Pull Request

All should work.

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:
No documentation changes for manual.joomla.org needed

Why?

The 12-factor app methodology recommends to store config in the environment.

Also, it makes Joomla more cloud-friendly and simplifies running it inside containers.

For example, using environment variables it's very easy to configure separate database for testing:

<?xml version="1.0" encoding="UTF-8"?>
<phpunit bootstrap="tests/Unit/bootstrap.php" colors="false">
        <testsuites>
                <testsuite name="Unit">
                        <directory suffix="Test.php">./tests/Unit</directory>
                </testsuite>
                <testsuite name="Integration">
                        <directory suffix="Test.php">./tests/Integration</directory>
                </testsuite>
        </testsuites>
        <php>
                <env name="JOOMLA_DBHOST" value="localhost" force="true"/>
                <env name="JOOMLA_DBNAME" value="joomla_test" force="true" />
                <env name="JOOMLA_DBUSER" value="joomla_test_user" force="true" />
                <env name="JOOMLA_DBPASSWORD" value="joomla_test_password" force="true" />
        </php>
</phpunit>

dgrammatiko · 2025-02-13T20:47:48Z

Nice one! One suggestion probably another array with key the JConfig key and value 1 if the value comes from the php file or 0 if the value comes from the env. the reason is that then in the admin configuration the form could check if each input is editable ie coming from the php file (or not ie coming from the env and then add a readonly attribute).

voronkovich · 2025-02-13T21:12:54Z

@dgrammatiko, to check if the config value came from environment we can use the envs_config service:

/** @var Registry */
$envsConfig = $container->get('envs_config');

if ($envsConfig->has('debug')) {
    // 'debug' came from environment
}

laoneo · 2025-02-20T12:43:27Z

Thanks for the pr. It's a nice idea. For me it is a bit too complex. Probably moving the loadEnvs function to the Config service provider is enough. No need to introduce a storage class with static functions.

voronkovich · 2025-02-20T13:14:52Z

@laoneo, without storage and static methods we can't set debug, error_reporting and behind_loadbalanser, because they are configured during application loading in includes/framework.php. So, JOOMLA_DEBUG, JOOMLA_ERROR_REPORTING wouldn't work.

laoneo · 2025-02-20T14:28:50Z

Then load them manually in the respective files.

…#44864)

voronkovich · 2025-02-20T16:56:39Z

@laoneo, I've added the changes you requested.

…ring) of type string is deprecated (joomla#44876)

libraries/src/Service/Provider/Config.php

laoneo · 2025-02-21T13:09:45Z

Just an update here, before you spend more time on it. We are discussing this in the maintainers team if it fits into our current setup. There are are already other ways to customize the config, so this would be another one.

tekvishal · 2025-02-22T08:10:38Z

I have tested this item 🔴 unsuccessfully on 2466eae

I have tested this item, issue not resolved

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

komalm · 2025-02-22T09:09:02Z

I have tested this item 🔴 unsuccessfully on 2466eae

Tested on: Joomla! 5.3-dev
Environment: Joomla! 5.3-dev (fresh setup)
Web Server: Apache
PHP Version: PHP 8.3
Database: MySQL

Steps Followed for Testing:

Applied the patch via Patch Tester.
Edited .htaccess file and added the environment variable: SetEnv JOOMLA_OFFLINE 1
Restarted the web server : sudo systemctl restart apache2
Opened the Joomla! frontend to check if the site was set to offline mode

Issue Observed:

The site did not switch to offline mode.
No errors were logged in Joomla! or the server error logs.
Environment variables were not detected by Joomla!

Expected Behavior:

Joomla! should recognize the JOOMLA_OFFLINE environment variable.
The site should display the "Site is offline" message if the variable is set to 1.

Actual Behavior:

Joomla! continues running normally, ignoring the JOOMLA_OFFLINE setting.
No difference observed before and after applying the patch.

Additional Notes:

Clearing Joomla! cache and restarting the server did not resolve the issue.

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

komalm · 2025-02-22T09:24:26Z

I have tested this item ✅ successfully on 2466eae

Sincerely apologize for my previous negative feedback regarding the issue. It was provided before properly applying the patch, and I realize now that it may not have reflected the actual results accurately.

After correctly applying the patch and retesting, here are my updated findings:

Tested on: Joomla! 5.3-dev
Environment: Joomla! 5.3-dev (fresh setup)
Web Server: Apache
PHP Version: PHP 8.3
Database: MySQL

Steps Followed for Testing:

Applied the patch via Patch Tester.
Edited .htaccess file and added the environment variable: SetEnv JOOMLA_OFFLINE 1
Restarted the web server : sudo systemctl restart apache2
Opened the Joomla! frontend to check if the site was set to offline mode

Issue Observed:

The site switch to offline mode.
No errors were logged in Joomla! or the server error logs.

Expected Behavior & Actual Behavior are same:

Joomla! should recognize the JOOMLA_OFFLINE environment variable.
The site should display the "Site is offline" message if the variable is set to 1.

Additional Notes:

Clearing Joomla! cache and restarting the server did not resolve the issue.

Final Result:

Patch works as intended; Joomla correctly recognizes the JOOMLA_OFFLINE variable, and the site goes offline as expected. No issues found.

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

The `CYPRESS_CACHE_FOLDER` environment variable must be set within the `sudo` command.

* [Cypress] PHP Backend Notice com_media/Files.cy.js Fixing all Joomla backend PHP notices from Cypress test file `api/com_media/Files.cy.js` and doing some refactoring. Fixed PHP notices are: ``` [Sat Feb 22 18:28:44.019593 2025] [php:notice] [pid 31:tid 31] [client 10.0.0.1:64714] PHP Notice: exif_imagetype(): Error reading from /var/www/html/files/test-image-1.jpg! in /var/www/html/libraries/src/Helper/MediaHelper.php on line 93 [Sat Feb 22 18:28:44.022074 2025] [php:notice] [pid 31:tid 31] [client 10.0.0.1:64714] PHP Notice: getimagesize(): Error reading from /var/www/html/files/test-image-1.jpg! in /var/www/html/libraries/src/Image/Image.php on line 177 [Sat Feb 22 18:28:44.258619 2025] [php:notice] [pid 31:tid 31] [client 10.0.0.1:64714] PHP Notice: exif_imagetype(): Error reading from /var/www/html/files/test-dir/test-image-1-subfolder.jpg! in /var/www/html/libraries/src/Helper/MediaHelper.php on line 93 [Sat Feb 22 18:28:44.259092 2025] [php:notice] [pid 31:tid 31] [client 10.0.0.1:64714] PHP Notice: getimagesize(): Error reading from /var/www/html/files/test-dir/test-image-1-subfolder.jpg! in /var/www/html/libraries/src/Image/Image.php on line 177 [Sat Feb 22 18:28:47.177357 2025] [php:notice] [pid 31:tid 31] [client 10.0.0.1:64714] PHP Notice: exif_imagetype(): Error reading from /var/www/html/files/test-dir/todelete.jpg! in /var/www/html/libraries/src/Helper/MediaHelper.php on line 93 [Sat Feb 22 18:28:47.178099 2025] [php:notice] [pid 31:tid 31] [client 10.0.0.1:64714] PHP Notice: getimagesize(): Error reading from /var/www/html/files/test-dir/todelete.jpg! in /var/www/html/libraries/src/Image/Image.php on line 177 [Sat Feb 22 18:28:47.564807 2025] [php:notice] [pid 31:tid 31] [client 10.0.0.1:64714] PHP Notice: exif_imagetype(): Error reading from /var/www/html/images/test-dir/todelete.jpg! in /var/www/html/libraries/src/Helper/MediaHelper.php on line 93 [Sat Feb 22 18:28:47.565288 2025] [php:notice] [pid 31:tid 31] [client 10.0.0.1:64714] PHP Notice: getimagesize(): Error reading from /var/www/html/images/test-dir/todelete.jpg! in /var/www/html/libraries/src/Image/Image.php on line 177 ``` All 8 x PHP notices are fixed. Instead of using 1-Byte files real images are used from Cypress fixtures. Please consider there are still 4 x PHP warning to be fixed (I assume they need to be fixed in PHP API backend code) from `api/com_media/Files.cy.js` and more warnings and notices in the overall Joomla System Tests. Some refactoring: * Deleted 3 images in `tests/System/data/com_media`, 2 are not used and Cypress default is to use `fixtures` folder * The image file names are counted through and the images show name and path in different colors. * Second `test-dir` was named `test-dir2` to distinguish clearly. * `afterEach()` is reduced to `after()`, as it is only a clean-up and not needed to execute the tests. * The last 4 tests can use the prepared files too, as with `beforeEach` the files are restored before each test. * Corrected Image Description to test-dir2 Used command: ``` convert -size 100x100 -gravity center -pointsize 11 xc:lightgreen -fill red -annotate +0+0 'Joomla\nSystem Tests\n\nimages/test-dir2\ntest-image-3.jpg' tests/System/fixtures/com_media/test-image-3.jpg ``` * Fix for Windows Path and Read-Only Overwrites - Creating relative fixtures folder path now also works on Windows with backslashes as separators and a drive letter - All overwrite files are now created with explicit read-write 0o666, as the default 0o444 creates read-only files, leading to PHP Warnings `Failed to open` --------- Co-authored-by: Allon Moritz <allon.moritz@digital-peak.com> Co-authored-by: Robert Deutz <rdeutz@googlemail.com>

) * Remove unsed variable * fix as reuested * Add a comment --------- Co-authored-by: Allon Moritz <allon.moritz@digital-peak.com> Co-authored-by: Benjamin Trenkle <bembelimen@users.noreply.github.com>

…2025-02-28

…2-28

Co-authored-by: Richard Fath <richard67@users.noreply.github.com>

…oomla#43430)

… channel or stability options (joomla#44954)

brianteeman · 2025-03-04T16:20:53Z

env.dist

+# JOOMLA_OFFLINE=1
+# JOOMLA_SITENAME='Joomla!'
+#
+# All available configuration values are listed in installation/configuration.php-dist.


is it ok to reference this file as it is removed once a site has been installed? Should it maybe refer to a documentation page that is always available?

tests/Unit/Libraries/Cms/Service/Provider/ConfigTest.php

Co-authored-by: Brian Teeman <brian@teeman.net>

HLeithner · 2025-03-04T17:18:43Z

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

voronkovich · 2025-03-04T22:11:28Z

I accidentally removed the branch while rebasing and the PR closed automatically. I will try to figure out how to reopen it later.

voronkovich requested a review from laoneo as a code owner February 13, 2025 15:53

joomla-cms-bot added PR-5.3-dev Unit/System Tests labels Feb 13, 2025

voronkovich force-pushed the config-envs branch 5 times, most recently from a62b167 to 4982dca Compare February 13, 2025 18:58

richard67 added the Feature label Feb 14, 2025

voronkovich force-pushed the config-envs branch from 4982dca to b3f9689 Compare February 20, 2025 12:36

SniperSister and others added 2 commits February 20, 2025 17:01

[5.2][system tests] Do not delete tuf metadata (joomla#44866)

Loading
Loading status checks…

741e775

Set column alias for BannerTable, fix warning on Save As Copy (joomla…

Loading
Loading status checks…

ec31a42

…#44864)

voronkovich force-pushed the config-envs branch from e9ea1bc to 9ff99f4 Compare February 20, 2025 17:21

joomla-translation-bot and others added 2 commits February 20, 2025 18:34

[5.2] Translation Update (joomla#44919)

Loading
Loading status checks…

f716005

[5.2] PHP Deprecated: trim(): Passing null to parameter joomla#1 ($st…

64ac8c8

…ring) of type string is deprecated (joomla#44876)

laoneo reviewed Feb 21, 2025

View reviewed changes

libraries/src/Service/Provider/Config.php Outdated Show resolved Hide resolved

drmenzelit and others added 4 commits February 25, 2025 14:57

Add border last element media breadcrumbs (joomla#44995)

4b5ff87

[5.2] Disable compat plugin for system tests (joomla#44997)

1a5ea16

[cypress] Update Menu.cy.js (joomla#45005)

97754e1

Update contact.xml (joomla#44988)

150f520

muhme and others added 16 commits February 28, 2025 07:33

[5.x][docu] Minor sudo fix (joomla#45031)

2e81829

The `CYPRESS_CACHE_FOLDER` environment variable must be set within the `sudo` command.

[5.3] Remove unsed variable messages from enqueue messages (joomla#42948

8a17a99

) * Remove unsed variable * fix as reuested * Add a comment --------- Co-authored-by: Allon Moritz <allon.moritz@digital-peak.com> Co-authored-by: Benjamin Trenkle <bembelimen@users.noreply.github.com>

Merge remote-tracking branch 'upstream/5.2-dev' into 5.3-dev-upmerge-…

457e5f4

…2025-02-28

Merge pull request joomla#45034 from richard67/5.3-dev-upmerge-2025-0…

a971099

…2-28

Fix mail background colour and line for Outlook (joomla#44985)

1ce0a30

[5.3] Remove useless sprintf function call (joomla#45036)

1bc1e8f

[5.3] fine grain task notification mail (joomla#44604)

eb65310

Co-authored-by: Richard Fath <richard67@users.noreply.github.com>

[5.3] CMSPlugin: Deprecate use of DispatcherAware and LanguageAware (j…

76918b0

…oomla#43430)

Fix code logic in admin controllers (joomla#45037)

e016edc

Merge branch '5.3-dev' into config-envs

44a7582

Remove un-used import (joomla#45042)

ebaced4

[5.3] Fix core update information retrieval after changing the update…

2c859aa

… channel or stability options (joomla#44954)

Merge branch '5.3-dev' into config-envs

8534235

Fix setting JDEBUG for installation

3a356f0

Tweak env.dist

f33da82

brianteeman reviewed Mar 4, 2025

View reviewed changes

tests/Unit/Libraries/Cms/Service/Provider/ConfigTest.php Outdated Show resolved Hide resolved

Update copyright year to 2025

634646e

Co-authored-by: Brian Teeman <brian@teeman.net>

HLeithner changed the base branch from 5.3-dev to 6.0-dev March 4, 2025 17:18

HLeithner requested a review from rdeutz as a code owner March 4, 2025 17:18

HLeithner changed the title ~~[5.3] Configure Joomla with environment variables~~ [6.0] Configure Joomla with environment variables Mar 4, 2025

joomla-cms-bot added PR-6.0-dev and removed Unit/System Tests Composer Dependency Changed labels Mar 4, 2025

voronkovich closed this Mar 4, 2025

voronkovich deleted the config-envs branch March 4, 2025 21:45

voronkovich mentioned this pull request Mar 4, 2025

[6.0][Dotenv] Configure Joomla with environment variables #45070

Open

4 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

GitHub Sponsors

[6.0] Configure Joomla with environment variables #44894

[6.0] Configure Joomla with environment variables #44894

voronkovich commented Feb 13, 2025 •

edited

Loading

dgrammatiko commented Feb 13, 2025

voronkovich commented Feb 13, 2025

laoneo commented Feb 20, 2025

voronkovich commented Feb 20, 2025

laoneo commented Feb 20, 2025

voronkovich commented Feb 20, 2025

laoneo commented Feb 21, 2025

tekvishal commented Feb 22, 2025

komalm commented Feb 22, 2025

komalm commented Feb 22, 2025

brianteeman Mar 4, 2025

HLeithner commented Mar 4, 2025

voronkovich commented Mar 4, 2025

[6.0] Configure Joomla with environment variables #44894

[6.0] Configure Joomla with environment variables #44894

Conversation

voronkovich commented Feb 13, 2025 • edited Loading

Summary of Changes

Testing Instructions

Actual result BEFORE applying this Pull Request

Expected result AFTER applying this Pull Request

Link to documentations

Why?

dgrammatiko commented Feb 13, 2025

voronkovich commented Feb 13, 2025

laoneo commented Feb 20, 2025

voronkovich commented Feb 20, 2025

laoneo commented Feb 20, 2025

voronkovich commented Feb 20, 2025

laoneo commented Feb 21, 2025

tekvishal commented Feb 22, 2025

komalm commented Feb 22, 2025

komalm commented Feb 22, 2025

brianteeman Mar 4, 2025

Choose a reason for hiding this comment

HLeithner commented Mar 4, 2025

voronkovich commented Mar 4, 2025

voronkovich commented Feb 13, 2025 •

edited

Loading