From 1339b7f13cc480144c3492a37d64e6fed6b2bfb8 Mon Sep 17 00:00:00 2001 From: Christoph Wurst Date: Tue, 17 Jun 2025 10:31:32 +0200 Subject: [PATCH] feat(devmanual): add section about system config key conventions Signed-off-by: Christoph Wurst --- .../basics/storage/configuration.rst | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/developer_manual/basics/storage/configuration.rst b/developer_manual/basics/storage/configuration.rst index afb26e8565c..e6d61832542 100644 --- a/developer_manual/basics/storage/configuration.rst +++ b/developer_manual/basics/storage/configuration.rst @@ -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 ``_``. 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 ----------