SOGo: Template Layers for Custom Configuration

[stephdl]

Description
Introduce template layers to make custom configuration of the web app easier.

Purpose

Simplify the process of customizing web app settings.

Proposed Solution

Implement pre-defined template layers that users can apply for customization.

Alternative Solutions

Provide detailed documentation for manual configuration.

Additional Context
These template layers should integrate smoothly with the current configuration process.

See Also

Related discussions on community.nethserver.org.

[stephdl]

Test Case: Installation, Configuration, and Validation of SOGo Version 2.0.3.dev-1

1. Install the SOGo Image

   • Install the ghcr.io/nethserver/sogo:2.0.3.dev-1 image.
     add-module ghcr.io/nethserver/sogo:2.0.3.dev-1

2. Install Required Components

   • Install an account provider.
   • Install the mail server.

3. Configure SOGo

   • Complete the configuration steps for SOGo.

4. Access and Use Verification

   • Verify that SOGo is accessible and functional by logging in and using the application.

5. Switch to sogo1 User

   • Run the command to become the sogo1 user:

     runagent -m sogo1

6. Copy and Edit Configuration Templates

   • Copy the necessary configuration template files:

     cp ../templates/sogo.conf templates/sogo.conf.local
     cp ../templates/SOGo.conf templates/SOGo.conf.local
     cp ../templates/cron.conf templates/cron.conf.local

   • Edit the copied files to add the comment # NethServer8_is_beautiful:

     vim templates/sogo.conf.local
     vim templates/SOGo.conf.local
     vim templates/cron.conf.local

7. Restart SOGo Service

   • Restart the SOGo service:

     systemctl restart --user sogo

8. Access and Use Verification (Post-Edit)

   • Verify again that SOGo is accessible and functional after the configuration changes.

9. Validate Configuration Edits

   • Search for the comment string in the configuration files to confirm that the edits were applied:

     grep -srni 'NethServer8_is_beautiful' .

   • Ensure that the configuration files in the config folder contain the added comment string.

[sogo10@R1 state]$ grep -srni 'NethServer8_is_beautiful' .
./config/sogo.conf:3:  /* # NethServer8_is_beautiful 10 Database configuration (mysql) */
./config/SOGo.conf:1:# NethServer8_is_beautiful
./config/cron-sogo:2:# NethServer8_is_beautiful
./templates/sogo.conf.local:3:  /* # NethServer8_is_beautiful 10 Database configuration (mysql) */
./templates/SOGo.conf.local:1:# NethServer8_is_beautiful
./templates/cron.conf.local:2:# NethServer8_is_beautiful

[stephdl]

Community verification asked to https://community.nethserver.org/t/sogo-new-features-configuration-template-and-access-configure-button/24906

[stephdl]

released https://github.com/NethServer/ns8-sogo/releases/tag/2.0.3