Feature: Persistent custom config-site.php in ns8-piler

[stephdl]

Support persistent custom configuration for config-site.php as implemented in ns8-piler PR #77.
Currently, custom admin changes to config-site.php are lost whenever the file is regenerated by module updates or UI saves. This feature allows an override template config-site.php.local to persist admin changes.

Proposed solution

• Check for a templates/config-site.php.local template in the module state directory
• If present, use it instead of the base template when generating config-site.php
• Scaffold a templates/ directory for local overrides
• If not present, keep current behavior

Alternative solutions

• Manually re-apply custom changes after updates (not ideal)
• Freeze config file from auto-generation (not flexible)

Additional context

See ns8-sogo persistent template logic for precedent. Improves admin experience and reduces config drift.

See also

• ns8-piler PR #77

---

thank @pagaille

[stephdl]

QA - Persistent custom config-site.php in ns8-piler

QA version : ghcr.io/nethserver/piler:1.2.2-dev.1

Test Case 1: Local template override

Steps:

1. Install ns8-piler module
2. Access the module state directory: runagent -m piler1
3. Copy base template: cp ../templates/config-site.php templates/config-site.php.local
4. Modify templates/config-site.php.local (e.g., enable IMAP auth or add a comment /// this is a comment)
5. Restart service: systemctl restart --user piler.service
6. Verify piler_etc/config-site.php contains custom changes

Expected result:

• Custom configuration persists after restart
• config-site.php reflects local template modifications

---

Test Case 2: No local template (default behavior)

Steps:

1. Install ns8-piler module
2. Ensure templates/config-site.php.local does not exist (rm the folder)
3. Start the service

Expected result:

• Base template is used
• Default config-site.php is generated
• No errors occur

---

Test Case 3: Persistence across module updates

Steps:

1. Create templates/config-site.php.local with custom settings
2. Trigger module update or UI configuration save
3. Check piler_etc/config-site.php content

Expected result:

• Custom template survives updates
• Custom settings remain intact

---

Test Case 4: Backup inclusion

Steps:

1. Create templates/config-site.php.local
2. Trigger module backup
3. Verify backup contents include state/templates directory

Expected result:

• Local template is included in backup
• Can be restored after module reinstall

[stephdl]

set all cases verified

[stephdl]

released https://github.com/NethServer/ns8-piler/releases/tag/1.2.2

thank @pagaille