This module intends to istall the SOGo groupware : https://www.sogo.nu/
Instantiate the module with:
add-module ghcr.io/nethserver/sogo:latest 1
The output of the command will return the instance name. Output example:
{"module_id": "sogo1", "image_name": "sogo", "image_url": "ghcr.io/nethserver/sogo:latest"}
You can retrieve the configuration with
api-cli run get-configuration --agent module/sogo1
Let's assume that the sogo instance is named sogo1.
Launch configure-module, by setting the following parameters:
host: a fully qualified domain name for the applicationlets_encrypt: enable or disable Let's Encrypt certificate (true/false)mail_server: the module UUID of the the mail server (only on NS8), for example24c52316-5af5-4b4d-8b0f-734f9ee9c1d9mail_domain: the mail domain used for user IMAP login and SOGo user identifier. It must correspond to a valid mail domain handled bymail_serverwhere user names are valid mail addresses tooldap_domain: a Ldap domain where to authenticate the users, it could be different than hostname. The ldap_domain is used to find an existing LDAP through LDAP proxyadmin_users: the administrator of SOGo, a comma separated list (user1,user2)workers_count: The number of workers for SOGo; you need to adapt it to the numbers of usersauxiliary_account: Allow users to set other email accounts inside the SOGo webmail (boolean)activesync: Enable the activesync protocom (boolean)dav: Enable the DAV protocol (caldav,cardav) (boolean)
Example:
api-cli run configure-module --agent module/sogo1 --data - <<EOF
{
"mail_server": "f38f9911-8341-452e-8941-d889385a59a8",
"ldap_domain": "ad.rocky9-pve4.org",
"admin_users" : "Administrator",
"mail_domain": "rocky9-pve4.org",
"lets_encrypt": false,
"host": "sogo3.rocky9-pve4.org",
"workers_count": "3",
"auxiliary_account": true,
"activesync": true,
"dav": true
}
EOF
The above command will:
- start and configure the SOGo instance
- configure a virtual host for trafik to access the instance
Some settings are not available in the UI, you need to change them manually, refer to documentation : https://www.sogo.nu/files/docs/SOGoInstallationGuide.html
ssh sogo1@::1
vim .config/state/environment
modify the settings, then restart sogo : systemctl restart --user sogo
BACKUPTIME=#30 0
DRAFTSFOLDER=Drafts
SENTFOLDER=Sent
SESSIONDURATION=1440
SOGOACLSSENDEMAILNOTIFICATIONS=NO
SOGOAPPOINTMENTSENDEMAILNOTIFICATIONS=YES
SOGOENABLEEMAILALARMS=YES
SOGOFOLDERSSENDEMAILNOTIFICATIONS=NO
SOGOINTERNALSYNCINTERVAL=30
SOGOMAXIMUMPINGINTERVAL=3540
SOGOMAXIMUMSYNCINTERVAL=3540
SOGOMAXIMUMSYNCRESPONSESIZE=2048
SOGOMAXIMUMSYNCWINDOWSIZE=100
SXVMEMLIMIT=512
WOWATCHDOGREQUESTTIMEOUT=60
SOGo must be tuned https://sogo.nu/files/docs/SOGoInstallationGuide.html#_microsoft_enterprise_activesync_tuning following the number of users, some settings can be tested.
Keep in mind to set one worker per active user for the activesync connection. The SXVMEMLIMIT https://sogo.nu/files/docs/SOGoInstallationGuide.html#_general_preferences could be be adjusted also, between 25MB to 45 MB per active user with the activesync service.
You can modify the configuration by adding new files to the folder /home/sogo1/.config/state/templates, if the files are present they are used instead of the default one and they are included in the backup of the module
- sogo configuration:
templates/sogo.conf.local - apache configuration:
templates/SOGo.conf.local - cron configuration:
templates/cron.conf.local
runagent -m sogo1
# copy the relevant files (copy and edit only the file you need)
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 files
vim template/sogo.conf.local
vim templates/SOGo.conf.local
vim templates/cron.conf.local
# restart the service
systemctl restart --user sogo
You can enable a database backup for each users of their addressbooks and their calendars, older entries more than 31 days are removed. The syntax is cron based, in the example it will be triggered each day at 00h30. the backup is disabled by default
- BACKUPTIME=#30 0
+ BACKUPTIME=30 0
you can restore the data with a tool sogo-restore-user, for example:
sogo-restore-user /var/lib/sogo/backups/sogo-2017-12-10_0030/ stephane
or for all users:
sogo-restore-user /var/lib/sogo/backups/sogo-2017-12-10_0030/ -A
The files for the theme custom_theme.js and the logo logo-full.svg to customize the SOGo instance sogo1 need to be located in /home/sogo1/.config/state and owned by user sogo1.
Here is an example of a custom_theme.js:
(function() {
'use strict';
angular.module('SOGo.Common')
.config(configure)
/**
* @ngInject
*/
configure.$inject = ['$mdThemingProvider'];
function configure($mdThemingProvider) {
var blueMap = $mdThemingProvider.extendPalette('indigo', {
'200': '#3e4044',
'300': '#292b30',
'1000': '#4C566A',
'50': '#313131',
'A100': '#444444',
'500': '#00558c',
'contrastDefaultColor': 'light',
'contrastLightColors': '50 100 200 300 400 500 600 A100 A200 A400 A700',
'contrastStrongLightColors': '700 800 900 A700'
});
$mdThemingProvider.definePalette('frost-grey', blueMap);
$mdThemingProvider.theme('default')
.primaryPalette('indigo', {
'default': '400',
'hue-1': '400',
'hue-2': '600',
'hue-3': 'A700'
})
.accentPalette('grey', {
'default': '400',
'hue-1': '300',
'hue-2': '500',
'hue-3': 'A700'
})
.backgroundPalette('grey');
$mdThemingProvider.generateThemesOnDemand(false);
}
})();
The sogo-app service file needs to be edited to add the files as volumes:
runagent -m sogo1 systemctl --user edit sogo-app
Following content needs to be written between the commented blocks to work. It's basically the ExecStart line from /home/sogo1/.config/systemd/user/sogo-app.service with 2 volumes added for the custom_theme.js and the sogo-full.svg.
This way the original ExecStart directive is overridden.
### Editing /home/sogo2/.config/systemd/user/sogo-app.service.d/override.conf
### Anything between here and the comment below will become the new contents of the file
[Service]
ExecStart=
ExecStart=/usr/bin/podman run --conmon-pidfile %t/sogo-app.pid \
--cidfile %t/sogo-app.ctr-id --cgroups=no-conmon \
--pod-id-file %t/sogo.pod-id --replace -d --name sogo-app \
--volume ./config/sogo.conf:/etc/sogo/sogo.conf:Z \
--volume ./config/cron-sogo:/etc/cron.d/cron-sogo:Z \
--volume ./config/sieve.creds:/etc/sogo/sieve.creds:Z \
--volume ./config/SOGo.conf:/etc/httpd/conf/extra/SOGo.conf:Z \
--volume ./backups:/etc/sogo/backups:Z \
--volume %S/state/custom_theme.js:/usr/lib/GNUstep/SOGo/WebServerResources/js/custom_theme.js:Z \
--volume %S/state/sogo-full.svg:/usr/lib/GNUstep/SOGo/WebServerResources/img/sogo-full.svg:Z \
${SOGO_SERVER_IMAGE}
### Lines below this comment will be discarded
Copy the original template to the templates directory to be able to customize it and to ensure it is included in the backup:
runagent -m sogo1 cp ../templates/sogo.conf ./templates/sogo.conf.local
Edit sogo.conf.local to add the custom theme:
runagent -m sogo1 nano templates/sogo.conf.local
Add following line at the end before the closing bracket:
SOGoUIAdditionalJSFiles = (js/custom_theme.js);
}
Restart the SOGo service to apply the changes:
runagent -m sogo1 systemctl --user restart sogo
To uninstall the instance:
remove-module --no-preserve sogo1
Test the module using the test-module.sh script:
./test-module.sh <NODE_ADDR> ghcr.io/nethserver/sogo:latest
The tests are made using Robot Framework
Translated with Weblate.
To setup the translation process:
- add GitHub Weblate app to your repository
- add your repository to [hosted.weblate.org]((https://hosted.weblate.org) or ask a NethServer developer to add it to ns8 Weblate project