Änderungen von Dokument Kopano Optimierungen

Zuletzt geändert von Jonas Mayer am 2022/05/23 12:53

Von Version 3.1
bearbeitet von Jens Gruber
am 2022/05/02 11:29
Änderungskommentar: Es gibt keinen Kommentar für diese Version
Auf Version 21.1
bearbeitet von Christian Germann
am 2022/05/09 09:07
Änderungskommentar: Es gibt keinen Kommentar für diese Version

Zusammenfassung

Details

Seiteneigenschaften
Dokument-Autor
... ... @@ -1,1 +1,1 @@
1 -XWiki.JensGruber@sbede
1 +XWiki.cge@sbede
Inhalt
... ... @@ -1,49 +1,32 @@
1 1  (% style="color:#000000" %)Es gibt mehrere Anpassungen die sich anbieten um den laufenden Betrieb von Kopano zu verbessern. Folgende Maßnahmen können optional genutzt werden:
2 2  
3 -{{toc start="5"/}}
3 +{{toc start="4"/}}
4 4  
5 5  
6 -===== (% style="color:#000000" %)**__Zustellbarkeit der Unzustellbarkeits-Nachrichten verbessern__**(%%) =====
6 +==== **1. Performance-Optimierung** ====
7 7  
8 -(% style="color:#000000" %)Es ist möglich die Zustellbarkeit der Unzustellbarkeits-Nachrichten für den Absender zu verbessern. Dafür ist es notwendig den SMTP-Server des gewählten Mailproviders als Smarthost einzutragen.
9 9  
9 +===== (% style="color:#000000" %)**__1.1 Kopano Leistung verbessern__**(%%) =====
10 10  
11 -(% style="color:#000000" %)Bearbeiten Sie in die Datei kopano-g1.yaml im puppeteer Container:
11 +(% style="color:#000000" %)Kopano ist in der Standardinstallation lediglich für den Betrieb von 10 Benutzern ausgelegt. Das heißt, die Kopano-Serverdienste reservieren mit den Standardeinstellungen sehr wenig Systemressourcen (RAM) und die Plattform arbeitet als Konsequenz sehr langsam, wenn deutlich mehr Benutzer ein Postfach erhalten. Man sollte daher in den meisten Fällen die zugeteilten Systemressourcen (deutlich) erhöhen, um ein vernünftiges Nutzererlebnis zu erzielen.
12 12  
13 -{{code language="bash"}}
14 -root@puppeteer:~ # vim /etc/logodidact/hiera/custom.d/kopano-g1.yaml
15 -{{/code}}
13 +(% style="color:#000000" %)Um die Einstellungen Puppet-gerecht zu definieren, hilft nachfolgende Auflistung von YAML-Einstellungen. Bei der Auswahl der Werte muss man die **Hardware-Ressourcen** des Servers berücksichtigen, im Beispiel wird von einem leistungsstarken Server mit **32GB** **RAM** und **2 CPU-Sockets** und insgesamt **32 Kernen** ausgegangen.
16 16  
17 17  
18 -(% style="color:#000000" %)Die Zeile "ld_kopano::postfix::hashes:" beschreibt das Handling für den Null-Sender. Fügen Sie nun die Zeile "<> smtp.meineschule.de" ein (Ergänzen Sie die smtp Adresse durch die von ihnen genutzte).
16 +(% style="color:#000000" %)Bearbeiten Sie in die Datei kopano-g1.yaml im puppeteer Container:
19 19  
20 20  {{code language="bash"}}
21 -ld_kopano::postfix::hashes:
22 -  '%{dir_etc}/sender_dependent_relayhost_maps_external.hash':
23 -    content: |
24 -      %{header}
25 -      <> smtp.meineschule.de
26 -      @meineschule.de smtp.meineschule.de
27 -{{/code}}
28 -
29 -
30 -===== (% style="color:#000000" %)**__Anbindung/Akkulaufzeit von Endgeräten verbessern__**(%%) =====
31 -
32 -(% style="color:#000000" %)Bei Verwendung des ActiveSync-Protokolls bzw. Kopano Z-Push zur Anbindung von Endgeräten (Smartphones, Tablets, MS Outlook 2013/2016/2019 Clients) empfiehlt es sich, auf die HTTP-KeepAlive Einstellungen für die Webserver-Dienste in der Verbindungskette (Rev-Proxy → Kopano-Server) Einfluss zu nehmen.
33 -
34 -(% style="color:#000000" %)Der KeepAlive-Wert wird bewusst hoch gewählt, damit Verbindungen zwischen Client und Kopano-Server länger offen gehalten werden können. Dadurch schont man die Batterie und Laufzeit von mobilen Geräten, da es sich u.a. auf den Standby-Betrieb von Smartphones auswirkt (der nicht permanent unterbrochen wird zum Starten einer neuen Verbindung).
35 -
36 -
37 -(% style="color:#000000" %)Zum erhöhen der TimeOuts öffnen Sie die kopano-g1.yaml:
38 -
39 -{{code language="bash"}}
40 40  root@puppeteer:~ # vim /etc/logodidact/hiera/custom.d/kopano-g1.yaml
41 41  {{/code}}
42 42  
22 +Passen Sie die kopano-g1.yaml je nach Größe der Schule an.
43 43  
44 -(% style="color:#000000" %)Fügen Sie folgende Zeilen am Ende der Datei ein:
24 +**kopano-g1.yaml r Kopano <50 Users:**
45 45  
46 -{{code language="bash"}}
26 +{{code language="yaml"}}
27 +nginx::keepalive_timeout: 3600
28 +nginx::keepalive_requests: 500
29 +
47 47  apache::keepalive: 'On'
48 48  apache::keepalive_timeout: '45'
49 49  apache::max_keepalive_requests: '500'
... ... @@ -50,43 +50,46 @@
50 50  apache::mod::prefork::maxclients: '384'
51 51  apache::mod::prefork::serverlimit: '384'
52 52  
53 -nginx::keepalive_timeout: 3600
54 -nginx::keepalive_requests: 500
36 +ld_kopano::server:
37 + settings:
38 + cache_cell_size: '512M'
39 + cache_object_size: '16M'
40 + cache_indexedobject_size: '32M'
41 + enable_sql_procedures: 'yes'
42 + # The following 2 settings require a cronjob to run periodically instead (in case the value is disabled)
43 + sync_gab_realtime: 'no'
44 + softdelete_lifetime: '0'
55 55  {{/code}}
56 56  
47 + **kopano-g1.yaml für Kopano >=50 Users**
57 57  
58 -(% style="color:#000000" %)Zusätzlich müssen Sie die Datei rev-proxy.yaml erstellen/bearbeiten:
59 -
60 -{{code language="bash"}}
61 -root@puppeteer:~ # vim /etc/logodidact/hiera/custom.d/rev-proxy.yaml
62 -{{/code}}
63 -
64 -
65 -(% style="color:#000000" %)Ergänzen/Befüllen Sie die Datei mit folgendem Inhalt:
66 -
67 -{{code language="bash"}}
49 +{{code language="yaml"}}
68 68  nginx::keepalive_timeout: 3600
69 69  nginx::keepalive_requests: 500
70 -{{/code}}
71 71  
53 +apache::keepalive: 'On'
54 +apache::keepalive_timeout: '45'
55 +apache::max_keepalive_requests: '500'
56 +apache::mod::prefork::maxclients: '500'
57 +apache::mod::prefork::serverlimit: '500'
72 72  
73 -===== (% style="color:#000000" %)**__Kopano Leistung verbessern__**(%%) =====
74 -
75 -(% style="color:#000000" %)Kopano ist in der Standardinstallation lediglich für den Betrieb von 10 Benutzern ausgelegt. Das heißt, die Kopano-Serverdienste reservieren mit den Standardeinstellungen sehr wenig Systemressourcen (RAM) und die Plattform arbeitet als Konsequenz sehr langsam, wenn deutlich mehr Benutzer ein Postfach erhalten. Man sollte daher in den meisten Fällen die zugeteilten Systemressourcen (deutlich) erhöhen, um ein vernünftiges Nutzererlebnis zu erzielen.
76 -
77 -(% style="color:#000000" %)Um die Einstellungen Puppet-gerecht zu definieren, hilft nachfolgende Auflistung von YAML-Einstellungen. Bei der Auswahl der Werte muss man die **Hardware-Ressourcen** des Servers berücksichtigen, im Beispiel wird von einem leistungsstarken Server mit **32GB** **RAM** und **2 CPU-Sockets** und insgesamt **32 Kernen** ausgegangen.
78 -
79 -
80 -(% style="color:#000000" %)Bearbeiten Sie in die Datei kopano-g1.yaml im puppeteer Container:
81 -
82 -{{code language="bash"}}
83 -root@puppeteer:~ # vim /etc/logodidact/hiera/custom.d/kopano-g1.yaml
59 +ld_kopano::server:
60 + settings:
61 + cache_cell_size: '6144M'
62 + cache_object_size: '32M'
63 + cache_indexedobject_size: '64M'
64 + enable_sql_procedures: 'yes'
65 + # The following 2 settings require a cronjob to run periodically instead (in case the value is disabled)
66 + sync_gab_realtime: 'no'
67 + softdelete_lifetime: '0'
84 84  {{/code}}
85 85  
70 +**kopano-g1.yaml für Kopano >=200 Users**
86 86  
87 -(% style="color:#000000" %)Folgende Parameter können ggf. helfen die Leistung zu verbessern:
72 +{{code language="yaml"}}
73 +nginx::keepalive_timeout: 3600
74 +nginx::keepalive_requests: 500
88 88  
89 -{{code language="bash"}}
90 90  apache::keepalive: 'On'
91 91  apache::keepalive_timeout: '45'
92 92  apache::max_keepalive_requests: '500'
... ... @@ -94,19 +94,18 @@
94 94  apache::mod::prefork::serverlimit: '500'
95 95  
96 96  ld_kopano::server:
97 -  settings:
98 -    cache_cell_size: '6144M'
99 -    cache_object_size: '16M'
100 -    cache_indexedobject_size: '32M'
101 -    enable_sql_procedures: 'yes'
102 -    # The following 2 settings require a cronjob to run periodically instead (in case the value is disabled)
103 -    sync_gab_realtime: 'no'
104 -    softdelete_lifetime: '0'
83 + settings:
84 + cache_cell_size: '12288M'
85 + cache_object_size: '256M'
86 + cache_indexedobject_size: '512M'
87 + enable_sql_procedures: 'yes'
88 + # The following 2 settings require a cronjob to run periodically instead (in case the value is disabled)
89 + sync_gab_realtime: 'no'
90 + softdelete_lifetime: '0'
105 105  {{/code}}
106 106  
93 +(% id="cke_bm_884S" style="color:#000000; display:none" %) (% style="color:#000000" %)Zusätzlich muss im Kopano-Container ein neuer CronJob eingerichtet werden, sofern man im Abschnitt **ld_kopano::server** die Parameter **sync_gab_realtime** / **softdelete_lifetime** im deaktivierten Zustand eingetragen hat:
107 107  
108 -(% style="color:#000000" %)Zusätzlich muss im Kopano-Container ein Cron-Job eingerichtet werden, sofern man im Abschnitt **ld_kopano::server** die Parameter **sync_gab_realtime** / **softdelete_lifetime** im deaktivierten Zustand eingetragen hat:
109 -
110 110  {{code language="bash"}}
111 111  root@kopano-g1:~ # /etc/cron.d/kopano-optimization
112 112  {{/code}}
... ... @@ -118,6 +118,8 @@
118 118  {{/code}}
119 119  
120 120  
106 +===== __**1.2 mysql56(% style="color:#000000" %) Leistung verbessern(%%)**__ =====
107 +
121 121  (% style="color:#000000" %)Folgende Einstellung können für die mysql56.yaml gesetzt werden:
122 122  
123 123  {{code language="bash"}}
... ... @@ -124,7 +124,7 @@
124 124  root@puppeteer:~ # vim /etc/logodidact/hiera/custom.d/mysql56.yaml
125 125  {{/code}}
126 126  
127 -{{code language="bash"}}
114 +{{code language="yaml"}}
128 128  mysql::server::override_options:
129 129   mysqldump:
130 130   max_allowed_packet: '1G'
... ... @@ -134,7 +134,7 @@
134 134   skip-name-resolve: true
135 135   innodb_large_prefix: true
136 136   innodb_file_format: 'Barracuda'
137 - max_allowed_packet: '256M'
124 + max_allowed_packet: '32M'
138 138   max_connections: '150'
139 139   query_cache_limit: '2M'
140 140   query_cache_size: '64M'
... ... @@ -157,97 +157,114 @@
157 157  {{/code}}
158 158  
159 159  
160 -===== (% style="color:#000000" %)__**Lokalisierung der Ordner-Strukturen**__(%%) =====
147 +===== __**1.3 mariadb103 (% style="color:#000000" %)Leistung verbessern(%%)**__ =====
161 161  
162 -(% style="color:#000000" %)Zur Lokalisierung der Ordnernamen empfiehlt es sich die Standard-Sprache für die Kopano-Postfächer auf "Deutsch" umzustellen. Führen Sie hierfür folgende Schritte durch:
149 +(% style="color:#000000" %)Folgende Einstellung nnen für die mariadb103.yaml gesetzt werden:
163 163  
164 -
165 -(% style="color:#000000" %)Wechseln Sie in den Kopano Container:
166 -
167 167  {{code language="bash"}}
168 -root@ldhost:~ # lxc-ssh -n kopano-g1
152 +root@puppeteer:~ # vim /etc/logodidact/hiera/custom.d/mariadb103.yaml
169 169  {{/code}}
170 170  
171 -
172 -(% style="color:#000000" %)Führen Sie folgenden Befehl im Kopano Container aus:
173 -
174 -{{code language="bash"}}
175 -root@kopano-g1:~ # echo 'default_store_locale = de_DE.UTF-8 ' >/etc/kopano/admin.cfg
155 +{{code language="yaml"}}
156 +mysql::server::override_options:
157 + mysqldump:
158 + max_allowed_packet: '1G'
159 + mysqld:
160 + innodb_file_per_table: '1'
161 + bind-address: '0.0.0.0'
162 + skip-name-resolve: true
163 + innodb_large_prefix: '1'
164 + max_allowed_packet: '32M'
165 + max_connections: '151'
166 + query_cache_limit: '2M'
167 + query_cache_size: '64M'
168 + thread_stack: '512K'
169 + tmp_table_size: '64M'
170 + max_heap_table_size: '64M'
171 + sort_buffer_size: '2M'
172 + join_buffer_size: '2M'
173 + table_open_cache: '500'
174 + innodb_autoextend_increment: '1000'
175 + innodb_buffer_pool_size: '1G'
176 + # The following setting is based on the existing ibdata1 file, check current size and insert it here (rounded to MB)
177 + innodb_data_file_path: 'ibdata1:12M:autoextend'
178 + innodb_flush_log_at_trx_commit: '2'
179 + innodb_flush_method: 'O_DSYNC'
180 + innodb_lock_wait_timeout: '120'
181 + innodb_log_buffer_size: '8M'
182 + innodb_log_file_size: '1G'
183 + innodb_log_files_in_group: '3'
184 + innodb_read_io_threads: '4'
185 + innodb_write_io_threads: '4'
176 176  {{/code}}
177 177  
188 +Passen Sie die {{code}}mariadb103.yaml{{/code}} noch folgendermaßen an für Große Umgebungen mit vielen Postfächern.
178 178  
179 -(% style="color:#000000" %)Nach ausführen des Befehls werden neu angelegte Kopano-Postfächer mit der korrekten Sprache erstellt. Für bereits erstellte/vorhandene Postfächer muss man einen extra Schritt durchhren. Setzen sie hierfür folgenden Befehl im Kopano Container ab:
190 +**mariadb103.yaml für Kopano >= 50 Users:**
180 180  
181 -{{code language="bash"}}
182 -root@kopano-g1:~ # kopano-localize-folders -u [username] --lang de_DE.UTF-8
192 +{{code language="yaml"}}
193 +sort_buffer_size: '4M'
194 +innodb_buffer_pool_size: '2G'
183 183  {{/code}}
184 184  
197 +(% class="wikigeneratedid" %)
198 +Quelle: [[https:~~/~~/kb.kopano.io/pages/viewpage.action?pageId=2654253>>https://kb.kopano.io/pages/viewpage.action?pageId=2654253]]
185 185  
186 -===== (% style="color:#000000" %)__**Public Folder erstellen**__(%%) =====
187 187  
188 -(% style="color:#000000" %)Es kann sich anbieten einen Public Folder als gemeinsamen Ordner für alle Benutzer zu erstellen. Hierfür müssen Sie folgenden Befehl eingeben:
201 +===== (% style="color:#000000" %)**__1.4 Anbindung/Akkulaufzeit von Endgeräten verbessern durch Konfiguration von HTTP KeepAlive__**(%%) =====
189 189  
190 -{{code language="bash"}}
191 -root@kopano-g1:~ # kopano-admin -s
192 -{{/code}}
203 +(% style="color:#000000" %)Bei Verwendung des ActiveSync-Protokolls bzw. Kopano Z-Push zur Anbindung von Endgeräten (Smartphones, Tablets, MS Outlook 2013/2016/2019 Clients) empfiehlt es sich, auf die HTTP-KeepAlive Einstellungen für die Webserver-Dienste in der Verbindungskette (Rev-Proxy → Kopano-Server) Einfluss zu nehmen.
193 193  
205 +(% style="color:#000000" %)Der KeepAlive-Wert wird bewusst hoch gewählt, damit Verbindungen zwischen Client und Kopano-Server länger offen gehalten werden können. Dadurch schont man die Batterie und Laufzeit von mobilen Geräten, da es sich u.a. auf den Standby-Betrieb von Smartphones auswirkt (der nicht permanent unterbrochen wird zum Starten einer neuen Verbindung).
194 194  
195 -===== (% style="color:#000000" %)__**Cronjob für Wartungsaufgaben**__(%%) =====
196 196  
197 -(% style="color:#000000" %)Durch das Anlegen eines zusätzlichen Cronjobs, lassen sich Wartungsaufgaben automatisch zu bestimmten Zeiten durchführen. Folgenden Cronjob können Sie bei Bedarf erstellen:
208 +[EINFÜGEN..... keeepAlive Settings in kopano-g1.yaml.... aus dem weiter oben dokumentierten Abschnitt dann entfernen]
198 198  
199 -{{code language="bash"}}
200 -# /etc/cron.d/kopano-optimization
201 -*/30 * * * * root [ -x /usr/sbin/kopano-admin ] && /usr/sbin/kopano-admin --sync 2>&1 >/dev/null
202 -0 4 * * * root [ -x /usr/sbin/kopano-admin ] && /usr/sbin/kopano-admin --purge-softdelete 30 2>&1 >/dev/null
203 -{{/code}}
204 204  
211 +(% style="color:#000000" %)Zusätzlich müssen Sie die Datei rev-proxy.yaml erstellen/bearbeiten:
205 205  
206 -===== (% style="color:#000000" %)**__Netzlaufwerke auf der Kopano-Weboberfläche anzeigen__**(%%) =====
207 -
208 -(% style="color:#000000" %)Empfehlenswert ist das Einbinden der Netzlaufwerke (H: / P: / T:) des logoDIDACT-Servers auf der Kopano Weboberfläche. Gehen Sie wie folgt vor um den Nutzern dies zu ermöglichen:
209 -
210 -
211 -(% style="color:#000000" %)Führen Sie den Sync über den kopano-admin durch:
212 -
213 213  {{code language="bash"}}
214 -root@kopano-g1:~ # kopano-admin --sync
214 +root@puppeteer:~ # vim /etc/logodidact/hiera/custom.d/rev-proxy.yaml
215 215  {{/code}}
216 216  
217 +(% style="color:#000000" %)Ergänzen/Befüllen Sie die Datei mit folgendem Inhalt:
217 217  
218 -(% style="color:#000000" %)Laden Sie folgendes Skript herunter:
219 -
220 220  {{code language="bash"}}
221 -root@kopano-g1:~ # wget https://files.sbe.de/kopano/install-inject-shares.sh -O /tmp/install-inject-shares.sh
220 +nginx::keepalive_timeout: 3600
221 +nginx::keepalive_requests: 500
222 222  {{/code}}
223 223  
224 224  
225 -(% style="color:#000000" %)Führen Sie das Skript aus:
225 +==== (% style="color:#000000" %)**2. Allgemeine Optimierungen der Einstellungen**(%%) ====
226 226  
227 -{{code language="bash"}}
228 -root@kopano-g1:~ # bash /tmp/install-inject-shares.sh
229 -{{/code}}
230 230  
228 +===== (% style="color:#000000" %)**__2.1 Zustellbarkeit der Unzustellbarkeits-Nachrichten verbessern durch Versenden per Relayhost__**(%%) =====
231 231  
232 -(% style="color:#000000" %)Das Installationsskript legt einen CronJob an, der zyklisch einmal pro Tag die Netzlaufwerke für alle Kopano-Benutzer registriert. Dieser Vorgang kann unmittelbar nach der Installation durch die Eingabe von folgendem Befehl direkt angestoßen werden:
230 +(% style="color:#000000" %)Es ist glich die Zustellbarkeit der Unzustellbarkeits-Nachrichten für den Absender zu verbessern. Dafür ist es notwendig den SMTP-Server des gehlten Mailproviders als Smarthost einzutragen.
233 233  
232 +
233 +(% style="color:#000000" %)Bearbeiten Sie in die Datei kopano-g1.yaml im puppeteer Container:
234 +
234 234  {{code language="bash"}}
235 -root@kopano-g1:~ # inject-shares.sh
236 +root@puppeteer:~ # vim /etc/logodidact/hiera/custom.d/kopano-g1.yaml
236 236  {{/code}}
237 237  
238 -(% style="color:#000000" %)**__Hinweis:__** Falls beim aufrufen des Skripts Mapi Fehler auftreten, bitte folgende Pakete installieren:(%%)
239 -
239 +(% style="color:#000000" %)Die Zeile "ld_kopano::postfix::hashes:" beschreibt das Handling für den Null-Sender. Fügen Sie nun die Zeile "<> smtp.meineschule.de" ein (Ergänzen Sie die smtp Adresse durch die von ihnen genutzte).
240 240  
241 241  {{code language="bash"}}
242 -python-mapi
243 -python-kopano
244 -python3-kopano-utils
245 -kopano-python-utils
242 +ld_kopano::postfix::hashes:
243 +  '%{dir_etc}/sender_dependent_relayhost_maps_external.hash':
244 +    content: |
245 +      %{header}
246 +      <> smtp.meineschule.de
247 +      @meineschule.de smtp.meineschule.de
246 246  {{/code}}
247 247  
248 248  
249 -===== (% style="color:#000000" %)__**Synchronisation der Benutzer in das globale Adressbuch**__(%%) =====
251 +(% style="color:#000000" %)__**2.2 Regelmäßige Synchronisation der Benutzer in das globale Adressbuch**__
250 250  
253 +
254 +
251 251  (% style="color:#000000" %)Durch einen Cronjob ist es möglich Benutzer in das Globale Adressbuch einzupflegen. Hierbei handelt es sich um eine Erweiterung für die Kopano Outlook Extension, damit Benutzer mit Kopano-Postfach automatisch im Adressbuch anwählbar sind.
252 252  
253 253  {{code language="bash"}}
... ... @@ -254,4 +254,4 @@
254 254  root@kopano-g1:~ # chmod +x /etc/cron.daily/gabsync
255 255  {{/code}}
256 256  
257 -(% style="color:#000000" %)__**Hinweis:**__ Dies stellt eine Erweiterung zum regulären ActiveSync-Protokoll durch Z-Push dar. Die Funktionsweise basiert auf einem synchronisierten Kontaktordner namens „Z-Push-KOE-GAB“ als Unterordner im Public Store / Öffentlichen Ordner.
261 +(% style="color:#000000" %)__**Hinweis:**__ Dies stellt eine Erweiterung zum regulären ActiveSync-Protokoll durch Z-Push dar. Die Funktionsweise basiert auf einem synchronisierten Kontaktordner namens „Z-Push-KOE-GAB“ als Unterordner im Public Store / Öffentlichen Ordner.