khanh.pndc/nextcloud-docs
1
0
Fork 0
mirror of https://github.com/nextcloud/documentation.git synced 2026-01-02 17:59:36 +07:00
Code Issues Packages Projects Releases Wiki Activity

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

Browse Source 
Signed-off-by: Christoph Wurst <christoph@winzerhof-wurst.at>
This commit is contained in:
Christoph Wurst
2025-06-17 10:31:32 +02:00
committed by backportbot[bot]
parent 0052bd61f7
commit 1339b7f13c
1 changed files with 16 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
developer_manual/basics/storage/configuration.rst
View File

@@ -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
----------