Manual Configuration options reference

User description

This PR adds a reference with all available configuration options (configuration.php).

See https://github.com/joomla/joomla-cms/pull/45070#discussion_r1981856214

PR Type

Documentation

Description

Added comprehensive configuration reference for Joomla settings.
Documented configuration categories: Cache, CORS, Database, Debug, Logging, Mail, Metadata, Proxy, SEO, Server, Session, Site.
Introduced a new index for configuration and reference documentation.
Provided examples and default values for each configuration option.

Changes walkthrough 📝

Relevant files

Documentation

14 files

cache.md `Added documentation for cache configuration settings`	+134/-0
cors.md `Added documentation for CORS configuration settings`	+46/-0
database.md `Added documentation for database configuration settings`	+112/-0
debug.md `Added documentation for debug configuration settings`	+44/-0
index.md `Introduced index for configuration reference documentation`	+4/-0
logging.md `Added documentation for logging configuration settings`	+68/-0
mail.md `Added documentation for mail configuration settings`	+114/-0
metadata.md `Added documentation for metadata configuration settings`	+52/-0
proxy.md `Added documentation for proxy configuration settings`	+48/-0
seo.md `Added documentation for SEO configuration settings`	+56/-0
server.md `Added documentation for server configuration settings`	+44/-0
session.md `Added documentation for session configuration settings`	+131/-0
site.md `Added documentation for site configuration settings`	+179/-0
index.md `Added reference index with a placeholder for content`	+7/-0

Need help?
Type /help how to ... in the comments thread for any questions about Qodo Merge usage.
Check out the documentation for more information.

Mar 09 '25 02:03 voronkovich

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

⏱️ Estimated effort to review: 2 🔵🔵⚪⚪⚪

🧪 No relevant tests

🔒 Security concerns

Sensitive information exposure:
The documentation includes examples with passwords and secrets (like database passwords, Redis auth keys, SMTP passwords, proxy passwords). While these are just examples, it would be better to use placeholder values like '[your-password]' instead of realistic-looking passwords like 'securepassword123' to avoid encouraging users to include actual credentials in configuration files.

⚡ Recommended focus areas for review

Typo

There's a typo in the path to the SSL key file example, where "youre" should be "your"

public $dbsslkey = '/path/to/youre/key.crt.pem';

Typo

There's a typo in the frontediting description where "menues" should be "menus"

Enable frontend editing: `0` (none), `1` (modules), `2` (modules &amp; menues)

Mar 09 '25 02:03 qodo-code-review[bot]

PR Code Suggestions ✨

Explore these optional code suggestions:

Category Suggestion Impact

General

Category	Suggestion	Impact
General	✅ ~~Add missing semicolon~~ Suggestion Impact: The commit added the missing semicolon at the end of the PHP statement exactly as suggested code diff: `- public $offline_message = 'Maintenance' + public $offline_message = 'Maintenance';` Add a semicolon at the end of the PHP statement to ensure proper syntax in the example code. docs/reference/configuration/site.md [30-31] - #### offline_message The message that will be displayed on the site when the site is offline. Default: `This site is down for maintenance.<br> Please check back again soon.` ```php - public $offline_message = 'Maintenance' + public $offline_message = 'Maintenance'; `[To ensure code accuracy, apply this suggestion manually]` <details><summary>Suggestion importance[1-10]: 8</summary> __ Why: The suggestion correctly adds a missing semicolon at the end of the PHP statement, which is essential for proper PHP syntax. This fix prevents potential errors if users copy the example directly. </details></details></td><td align=center>Medium </td></tr><tr><td> <details><summary>✅ <s>Fix typo in example path</s></summary> ___ <details><summary><b>Suggestion Impact:</b></summary>The commit implemented exactly the suggested change, fixing the typo in the example path by changing 'youre' to 'your' in the SSL key file path example code diff: ```diff - public $dbsslkey = '/path/to/youre/key.crt.pem'; + public $dbsslkey = '/path/to/your/key.crt.pem'; Fix the typo in the path example for the SSL key file. The word "youre" should be "your" to maintain professionalism in the documentation. docs/reference/configuration/database.md [87-88] - #### dbsslkey The path to the SSL/TLS key file used for database connections. ```php - public $dbsslkey = '/path/to/youre/key.crt.pem'; + public $dbsslkey = '/path/to/your/key.crt.pem'; `[To ensure code accuracy, apply this suggestion manually]` <details><summary>Suggestion importance[1-10]: 7</summary> __ Why: The suggestion correctly identifies and fixes a typo in the example path where "youre" should be "your". This improves the professionalism and readability of the documentation. </details></details></td><td align=center>Medium </td></tr><tr><td> <details><summary>✅ <s>Fix spelling error</s></summary> ___ <details><summary><b>Suggestion Impact:</b></summary>The commit implemented the exact spelling correction suggested, changing 'menues' to 'menus' in the frontediting option description code diff: ```diff - Enable frontend editing: `0` (none), `1` (modules), `2` (modules & menues) + Enable frontend editing: `0` (none), `1` (modules), `2` (modules & menus) Correct the spelling of "menues" to "menus" in the description of the frontediting option. docs/reference/configuration/site.md [117] - #### frontediting - Enable frontend editing: `0` (none), `1` (modules), `2` (modules & menues) + Enable frontend editing: `0` (none), `1` (modules), `2` (modules & menus) Default: `1` ```php public $frontediting = 2; `[To ensure code accuracy, apply this suggestion manually]` <details><summary>Suggestion importance[1-10]: 6</summary> __ Why: The suggestion correctly identifies and fixes the spelling error "menues" to "menus" in the documentation, improving the overall quality and professionalism of the documentation. </details></details></td><td align=center>Low </td></tr> <tr><td align="center" colspan="2"> - [ ] Update <!-- /improve --more_suggestions=true --> </td><td></td></tr></tbody></table>

✅ ~~Add missing semicolon~~

Suggestion Impact:

The commit added the missing semicolon at the end of the PHP statement exactly as suggested

code diff:

-  public $offline_message = 'Maintenance'
+  public $offline_message = 'Maintenance';

Add a semicolon at the end of the PHP statement to ensure proper syntax in the
example code.

docs/reference/configuration/site.md [30-31]

 - #### offline_message
 
   The message that will be displayed on the site when the site is offline.
 
   Default: `This site is down for maintenance.<br> Please check back again soon.`
 
   ```php
-  public $offline_message = 'Maintenance'
+  public $offline_message = 'Maintenance';



`[To ensure code accuracy, apply this suggestion manually]`

<details><summary>Suggestion importance[1-10]: 8</summary>

__

Why: The suggestion correctly adds a missing semicolon at the end of the PHP statement, which is essential for proper PHP syntax. This fix prevents potential errors if users copy the example directly.


</details></details></td><td align=center>Medium

</td></tr><tr><td>



<details><summary>✅ <s>Fix typo in example path</s></summary>

___

<details><summary><b>Suggestion Impact:</b></summary>The commit implemented exactly the suggested change, fixing the typo in the example path by changing 'youre' to 'your' in the SSL key file path example

code diff:

```diff
-  public $dbsslkey = '/path/to/youre/key.crt.pem';
+  public $dbsslkey = '/path/to/your/key.crt.pem';

Fix the typo in the path example for the SSL key file. The word "youre" should
be "your" to maintain professionalism in the documentation.

docs/reference/configuration/database.md [87-88]

 - #### dbsslkey
 
   The path to the SSL/TLS key file used for database connections.
 
   ```php
-  public $dbsslkey = '/path/to/youre/key.crt.pem';
+  public $dbsslkey = '/path/to/your/key.crt.pem';



`[To ensure code accuracy, apply this suggestion manually]`

<details><summary>Suggestion importance[1-10]: 7</summary>

__

Why: The suggestion correctly identifies and fixes a typo in the example path where "youre" should be "your". This improves the professionalism and readability of the documentation.


</details></details></td><td align=center>Medium

</td></tr><tr><td>



<details><summary>✅ <s>Fix spelling error</s></summary>

___

<details><summary><b>Suggestion Impact:</b></summary>The commit implemented the exact spelling correction suggested, changing 'menues' to 'menus' in the frontediting option description

code diff:

```diff
-  Enable frontend editing: `0` (none), `1` (modules), `2` (modules &amp; menues)
+  Enable frontend editing: `0` (none), `1` (modules), `2` (modules &amp; menus)

Correct the spelling of "menues" to "menus" in the description of the
frontediting option.

docs/reference/configuration/site.md [117]

 - #### frontediting
 
-  Enable frontend editing: `0` (none), `1` (modules), `2` (modules &amp; menues)
+  Enable frontend editing: `0` (none), `1` (modules), `2` (modules &amp; menus)
 
   Default: `1`
 
   ```php
   public $frontediting = 2;



`[To ensure code accuracy, apply this suggestion manually]`

<details><summary>Suggestion importance[1-10]: 6</summary>

__

Why: The suggestion correctly identifies and fixes the spelling error "menues" to "menus" in the documentation, improving the overall quality and professionalism of the documentation.

</details></details></td><td align=center>Low

</td></tr>
<tr><td align="center" colspan="2">

- [ ] Update <!-- /improve --more_suggestions=true -->

</td><td></td></tr></tbody></table>

Mar 09 '25 02:03 qodo-code-review[bot]

The use of headings for bold leads to accessibility violations. An alternative would be to put all these items in one file with h2 for each section and h3 for each item - not a bullet list.

Mar 09 '25 06:03 ceford

@ceford, I've replaced bullets with h3 headings.

Mar 09 '25 15:03 voronkovich

as cliff said, I also don't think that wee need 13 files for our configuration page... can you combine this into one file and maybe group it in source code block per section?

Mar 09 '25 15:03 HLeithner

@HLeithner, done. I've combined all files into a single one.

Mar 09 '25 15:03 voronkovich

@HLeithner, Could you please explain what you mean here:

and maybe group it in source code block per section

Mar 09 '25 15:03 voronkovich

Something like this for each section?

public $cors = true;
public $cors_allow_headers = 'Content-Type,X-Joomla-Token,Authorization';
public $cors_allow_methods = 'GET,POST';
public $cors_allow_origin = 'https://example.com,https://another-domain.com';

Mar 09 '25 15:03 voronkovich