Skip to main content
xorlab follows semantic versioning using the Major.Minor.Patch format. For example, 9.X.2 means patch no. 2 to the Xth minor release of the 9th major version of the software. This guide supports system administrators in upgrading XSP to a new minor or major release while ensuring minimal disruption. Before proceeding, ensure that you have a recent backup in place. Refer to Manual backup and Patch Rollback for detailed instructions.

Release support lifecycle

xorlab follows a time-based release support lifecycle. Each major release is supported for 9 months after its initial public release. Customers are expected to upgrade xorlab at least twice per year to remain within a supported release. Please refer to the Release Lifecycle Support page to verify support timelines and end-of-support dates.

Release notes

Below is a summary of major changes in version 9.0.X. For a complete list of changes, refer to the Changelog.
  • New SSQ release feature: End-users can now request the release of quarantined emails directly via their SSQ. The feature can be enabled individually per quarantine, and is per default deactivated.
  • Hot-reload for authentication settings: Configuration changes to LDAP, SAML, and other authentication integrations no longer require a service restart.
  • Enhanced email authentication insights: SPF, DKIM, and DMARC alignment results are now summarized in the message detail view.
  • Improved multi-tenant support: SSQ configuration and data retention settings are now fully multi-tenant capable and can be managed separately for each domain.

Breaking changes

  • [SA-14037] Rules: The following MTA trust lists were removed:
    • MTA EHLO trust list for guarded (regex)
    • MTA EHLO trust list for partner (regex)
    • MTA RDNS trust list for guarded (regex)
    • MTA RDNS trust list for partner (regex)
    If you’re using any of these lists and want to keep these MTA entries trusted, make sure to manually migrate them to the trustedMTAProfiles in active_guard.yml. See more information here: https://docs.xorlab.com/9.0/trusted-mtas/. Also removed are the following rule templates: sender_is_trusted_ehlo_for_guarded.xml, sender_is_trusted_ehlo_for_partner.xml, sender_is_trusted_reverse_dns_for_guarded.xml and sender_is_trusted_reverse_dns_for_partner.xml If any custom rule exists that relies on these templates (e.g., if it uses <template name="sender_is_trusted_ehlo_for_guarded"/> anywhere), the rule will stop working.
  • [SA-14284] XCC: All configuration parameters related to data retention were moved from xcc.yml to guarded_tenants.yml, see Data Retention. Additionally, all SSQ related configuration parameters were also moved from xcc.yml to guarded_tenants.yml, see SSQ. No action is required from your side.
  • [SA-14354] MTA: Only consider TXT DNS records when verifying SPF, ignore SPF DNS records. Please ensure all your guarded domains have valid SPF entries in their TXT DNS records.

Upgrade Process

Order of Process

Upgrade XSP Services in the following order:
  1. Sandbox (for an on-premises instance)
  2. XCC
  3. MTA
If multiple services run on the same host, the migration script ensures the correct order automatically.

Execute the Script

Run the following command as the admin user on each host, following the upgrade order above:
After you ran the script on every host, the process of upgrading XSP to the new release is finished.

Post-upgrade actions

During the migration period, it’s important to check the migration logs for any warnings or errors that may occur. To do this, use the following link (be sure to replace <xcc_domain:xcc.customer.tld> with your actual XCC domain in the browser):
We recommend reviewing the warnings carefully to ensure a successful migration. If you have any questions or issues, please do not hesitate to contact us at support@xorlab.com.

New features configuration

After upgrading, review the documentation pages below for new features introduced in version 9.0.X and apply configurations as needed.

Troubleshooting

If you experience issues or have questions, refer to the support documentation or contact our support team at support@xorlab.com.