Skip to content

Configuration options reference #479

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.

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

voronkovich
Copy link

@voronkovich voronkovich commented Jun 3, 2025

User description

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

This is an updated version of #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
    Copy link
    Author

    @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 voronkovich force-pushed the dotenv-configuration-php branch from fc085ce to 263328e Compare June 3, 2025 08:30
    @Fedik
    Copy link
    Member

    Fedik commented Jun 3, 2025

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

    @voronkovich

    This comment was marked as resolved.

    @voronkovich
    Copy link
    Author

    @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 voronkovich force-pushed the dotenv-configuration-php branch from 4dd685d to 5cc172e Compare June 4, 2025 02:13
    @voronkovich voronkovich marked this pull request as ready for review June 4, 2025 03:35
    Copy link
    Contributor

    qodo-merge-pro bot commented Jun 4, 2025

    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>
    

    Copy link
    Contributor

    qodo-merge-pro bot commented Jun 4, 2025

    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

    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    2 participants