Skip to content

feat(devmanual): add section about system config key conventions #13238

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.

Sign up for GitHub

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 3 commits into
base: master
Choose a base branch
from
Open

feat(devmanual): add section about system config key conventions #13238

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b8e3689
feat(devmanual): add section about system config key conventions
ChristophWurst Jun 17, 2025
98eab13
fixup! feat(devmanual): add section about system config key conventions
ChristophWurst Jun 17, 2025
e09a5aa
fixup! feat(devmanual): add section about system config key conventions
ChristophWurst Jun 17, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions developer_manual/basics/storage/configuration.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,22 @@ System values are saved in the :file:`config/config.php` and allow the app to mo

.. note:: It's also possible to use ``getSystemValueBool``, ``getSystemValueString``, ``getSystemValueInt`` to get type hinted return values.

Naming conventions
~~~~~~~~~~~~~~~~~~

For consistency there are conventions for config keys:

* System config keys should only contain lower case letters, numbers and ``_``. This ensures that they can be used as environment variables.
* Keys can be scoped to subsystems like ``<subsystem>_<key>``. This makes it easier to group related configuration.

Here are some examples:

1. ``files_external_allow_create_new_local``
2. ``filesystem_cache_readonly``
3. ``log_rotate_size``
4. ``mail_smtpname``
5. ``session_lifetime``

App values
----------

Expand Down
Loading