Manual icon indicating copy to clipboard operation
Manual copied to clipboard

Configuration options reference

Open voronkovich opened this issue 6 months ago • 6 comments

User description

This PR adds a reference with all available configuration options and corresponding environment variables (configuration.php). See: https://github.com/joomla/joomla-cms/pull/45523

This is an updated version of https://github.com/joomla/Manual/pull/429


PR Type

Documentation


Description

  • Add comprehensive reference for all configuration options

    • Includes mapping to environment variables and configuration.php
    • Covers caching, database, mail, session, SEO, and more
    • Provides example configuration snippets for PHP and .env
  • Add placeholder for unfinished reference index page


Changes walkthrough 📝

Relevant files
Documentation
configuration.md
Add exhaustive configuration and environment variable reference

docs/reference/configuration.md

  • Introduces a detailed reference for all Joomla configuration options
  • Maps each option to its corresponding environment variable
  • Provides default values, descriptions, and example usage in
    configuration.php and .env
  • Covers all major configuration areas: caching, cookies, CORS,
    database, debug, logging, mail, metadata, proxy, SEO, server, session,
    and site
  • +1106/-0
    index.md
    Add placeholder for reference index page                                 

    docs/reference/index.md

  • Adds a placeholder reference index page with a TODO notice
  • Encourages community contributions to complete the page
  • +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.
  • voronkovich avatar Jun 03 '25 07:06 voronkovich

    @Fedik, I've found that these options don't have corresponding envs:

    • asset_id
    • session_metadata_for_guest
    • session_memcached_server_id
    • feed_limit
    • feed_email

    Add support for them in your PR, please.

    voronkovich avatar Jun 03 '25 07:06 voronkovich

    asset_id probably can ignore, I did not found why it is needed. Others I will update later.

    Fedik avatar Jun 03 '25 08:06 Fedik

    @Fedik, the asset_id is used for cache busting:

    Cache busting is a technique used by web developers to force the browser to load the most recent version of a file, rather than a previously cached version.

    I think you better add support for it.

    voronkovich avatar Jun 03 '25 09:06 voronkovich

    @Fedik, I've just checked the Joomla source code and didn't find any usage of the asset_id. So, maybe you're right - it's a totally useless parameter.

    voronkovich avatar Jun 03 '25 10:06 voronkovich

    PR Reviewer Guide 🔍

    Here are some key observations to aid the review process:

    ⏱️ Estimated effort to review: 2 🔵🔵⚪⚪⚪
    🧪 No relevant tests
    🔒 No security concerns identified
    ⚡ Recommended focus areas for review

    Typo

    There's a typo in the environment variable name for site feed email. It's written as "JOOMLE_SITE_FEED_EMAIL" instead of "JOOMLA_SITE_FEED_EMAIL".

    Env: `JOOMLE_SITE_FEED_EMAIL`
    
    
    Inconsistent Example

    The environment variable in the example code uses the typo "JOOMLE_SITE_FEED_EMAIL" which matches the incorrect variable name in the documentation above, but should be corrected to "JOOMLA_SITE_FEED_EMAIL".

    JOOMLE_SITE_FEED_EMAIL=author
    
    
    </details>
    
    </td></tr>
    </table>
    

    qodo-code-review[bot] avatar Jun 04 '25 03:06 qodo-code-review[bot]

    PR Code Suggestions ✨

    Explore these optional code suggestions:

    CategorySuggestion                                                                                                                                    Impact
    General
    Fix environment variable typo
    Suggestion Impact:The commit fixed the typo in the environment variable name exactly as suggested, changing JOOMLE_SITE_FEED_EMAIL to JOOMLA_SITE_FEED_EMAIL in both locations where it appeared in the document

    code diff:

    -Env: `JOOMLE_SITE_FEED_EMAIL`
    +Env: `JOOMLA_SITE_FEED_EMAIL`
     
     ### Example
     
    @@ -1102,5 +1102,5 @@
     JOOMLA_SITE_OFFLINE_IMAGE=images/offline.png
     
     JOOMLA_SITE_FEED_LIMIT=20
    -JOOMLE_SITE_FEED_EMAIL=author
    

    There's a typo in the environment variable name. It should be
    JOOMLA_SITE_FEED_EMAIL instead of JOOMLE_SITE_FEED_EMAIL to maintain consistency
    with other environment variable naming patterns.

    docs/reference/configuration.md [1105]

    -JOOMLE_SITE_FEED_EMAIL=author
    +JOOMLA_SITE_FEED_EMAIL=author
    

    [Suggestion processed]

    Suggestion importance[1-10]: 6

    __

    Why: The suggestion correctly identifies a typo in the environment variable name JOOMLE_SITE_FEED_EMAIL which should be JOOMLA_SITE_FEED_EMAIL to maintain consistency with the naming pattern used throughout the document.

    Low
    • [ ] Update

    qodo-code-review[bot] avatar Jun 04 '25 03:06 qodo-code-review[bot]