Zammad 3.2 is available

Better late than never: As most of you already noticed - Zammad 3.2 is out.

1. Big changes

1.1 Performance

This release brings great performance optimisations.
Not just good for your CPU load but also affects the memory consumption of Zammad which saves up to 38% memory (in comparison to earlier versions) in long time run.

1.2 Chat enhancements

3.2 comes with several enhancements for the Chat function:
You can now disable the display of the agents Avatar and even define a custom display name. This is a great plus if you don’t want to get too personal and e.g. keep your last name a secret!

Beside that, you can finally transfer active chats in between chat topics!
Amazing right? This allows you to switch support levels if needed!

1.3 Link-Templates for Objects

Zammad now allows you to define objects as a link template, which allows you to create clickable URLs all toegether with variables from Zammad. With this you can jump onto a specific location in your CRM or feed other systems with specific information when calling the URL. (not automatic).

Further information on this feature can be found on our documentation:
https://admin-docs.zammad.org/en/latest/system/objects.html#url-fields-link-template

1.3.1 Known issue

Please note that link templates currently have technical limitations, for more information please see:

1.4 Group based Macros

Macros can now be dependend to specific groups if needed.
This helps administrators to keep the UI as clean and simple as possible!

1.5 SAML authentication

SAML is our newest authentication option in Zammad that allows you to authenticate your users centrrally via SSO if needed. This allows you to integrate various identity providers just like Keycloak, Gluu, PrivacyIDEA and more!

You can find more information about this functionality on our documentation:
https://admin-docs.zammad.org/en/latest/settings/security/third-party/saml.html

1.6 Oversized e-mail handling

Finally Zammad allows you to handle too big mails better!
By default Zammad will reply to oversized Mails telling the user to please reduce the size (and the limit) and removes the mail from it’s mailbox.

Don’t worry, the mail is not lost and will be saved within /opt/zammad/tmp/oversized-emails/ for manual review if needed. If you disable this function, Zammad will now give hints to oversized mails within the Monitoring.

On earlier versions administrators had to check for such issues manually which could cause Mails to lay too long and result in unhappy customers.

The above settings can be found within E-Mail-Channel (Settings-Tab).

1.7 various bug fixes

Of course we’ve been working hard on fixing issues.
You can find the changelog for 3.2 here: https://github.com/zammad/zammad/blob/stable/CHANGELOG.md

2 Important technical notes

2.1 CSRF token verification failed

Due to internal changes, most of the existing proxy configurations will be troublesome. Thanks to the great effort of our community members the issue could be found fast (see: Fresh install 3.2.x: CSRF token verification failed ).

The following configuration workaround will solve the issue.
We’re currently working on fixing commits that will provide a correct sample configuration for the future. Please bear with us. :pray:

2.1.1 Apache2 users

If you’re using Apache2, add the following two lines to your Zammad vHost-configuration file to solve the above error. By the way, the location it self doesn’t matter, as long as you’re inside the vHost directive.

RequestHeader set X_FORWARDED_PROTO 'https' 
RequestHeader set X-Forwarded-Ssl on

If not already done, you’ll also need to enable mod_headers with: a2enmod headers.
Don’t forget to restart apache afterwards: systemctl restart apache2

2.1.2 nginx users

nginx users have to options, which is why I’m dividing this by a “super fast” and “not so fast” way :wink:

super fast way

The quickest (and hardcoded) way to solve this is to edit your Zammad vHost-configuration file by removing the following line (this line exists twice, so you need to replace both places).

proxy_set_header X-Forwarded-Proto $scheme;

and replacing it by

proxy_set_header X-Forwarded-Proto https;

If your configuration file does not have above line, add it.
Don’t forget to reload your nginx.

not so fast way

Note: This is currently an untested way that has been suggested by @lr1980 (thanks!).

If you want your configuration to be more dynamic you can add the following within the server directive for your Zammad vHost:

map $http_x_forwarded_proto $real_scheme {
default $http_x_forwarded_proto;
‘’ $scheme;
}

Now replace both of the following lines.

proxy_set_header X-Forwarded-Proto $scheme;

by

proxy_set_header X-Forwarded-Proto $real_scheme;

and reload your nginx.

2.2 Changes to the Elasticsearch Indices

Please note that updating to Zammad 3.2 requires you to rebuild your searchindex!
This is due to changes on the layout. Not rebuilding your searchindex will cause Zammad not to work as expected when searching for stuff.

You can rebuild your index with:
zammad run rake searchindex:rebuild

2.3 Compatibility to Elasticsearch

Also, please note that Elasticsearch 7.5 is a fairly new release.
That being said, please note that Zammad prior 3.2 does not support Elasticsearch 7.5!

You need a current Zammad 3.2 to use Elasticsearch 7.5.x!

Zammad version Supported Elasticsearch version
2.x - 3.0 2.4.x up to 5.6.x
3.1 2.4 up to 7.4.x
3.2 2.4 up to 7.5.x

Please keep in mind that Elasticsearch 5.6 is end of life, so you might want to update.
You can find the upgrade path here: https://www.elastic.co/guide/en/elasticsearch/reference/current/setup-upgrade.html


That’s it for now, enjoy and happy hacking! :rocket:

12 Likes