Skip to content

Upgrading an Existing Installation

The Lime Bootstrap apps and VBA modules must always be manually upgraded.

Upgrading to 3.8.5

Due to a breaking change in the web client, making it impossible to create a new token, the token endpoint has been deprecated. The LBS app should be updated (as always) to prepare for when the old token endpoint is removed.

Upgrading to 3.8.x

Client permissions are now enforced at the endpoints. This means that these must be configured, if not already done, for the Lime Bootstrap apps to continue working. Otherwise clicking the actions in the Lime Bootstrap apps could result in an Unauthorized error.

Simply: if the Desktop client is used, the Client permissions in Lime Admin must mirror the groups in the Lime Bootstrap app configuration.

From 3.x

Review the Client permissions in Lime Admin.

From 1.x or 2.x

If upgrading directly to 3.8.x or newer from 1.x or 2.x, the migration script will set missing Client permissions to the recommended ones as seen in the example Base configuration. Review the migrated configuration and adjust if needed.

Upgrading to 3.x

GDPR now has a schema that makes configuring the GDPR add-on much easier in Lime Admin. As a consequence of this large rewrite, the configuration generator and support for migrating from 0.x was removed.

From 1.x or 2.x

The configuration will be migrated automatically. Customers that are using the Lime Bootstrap apps must adjust the groups in Client permissions in Lime Admin to mirror the groups in the Lime Bootstrap app configuration.

From 0.x

Since the configuration is completely different in 0.x than newer versions, a direct upgrade from 0.x to 3.x is not possible. There are essentially two ways of doing the upgrade:

  • Upgrade from 0.x to 2.x. Then upgrade from 2.x to 3.x.

or

  • Write down the YAML config from 0.x. Install 3.x. Manually configure the GDPR and Consent add-ons from scratch, using the YAML config as reference.

Upgrading to 2.x

The major difference from 1.x is support for the new object card in the Lime CRM web client. A migration script will automatically try to move the configuration for the GDPR web component. See configuration of web component how to manually fix if the GDPR web component does not show up after an upgrade.

Upgrading to 1.x

When upgrading from 0.x to 1.x the configuration will be automatically upgraded, but there are a few manual steps:

  • Delete all old Lime Bootstrap apps: GDPR, Consent, BulkConsent
  • Delete the GDPR VBA module and replace it with the AO_GDPR VBA module
  • Install the addon_gdpr Bootstrap app from 1.x and install the consent apps from the consent add-on.
  • Check that the configuration of the Bootstrap apps is correct.
  • In Lime Admin, adjust client_permissions. These are the web component equivalents to the Lime Bootstrap apps permissions settings that control which user groups the web component is displayed for.
  • Ensure that the Consent configuration was properly migrated (see below)

Upgrading Bootstrap apps from 0.x to 1.x

It's important to upgrade the Bootstrap apps to 1.x. The old 0.x apps are deprecated, but will continue to work for a limited time. The reason for this is that Lime CRM server version in the cloud is automatically upgraded, but it's impossible to automatically upgrade the Bootstrap apps. Because of that, backwards compatibility was added to allow manual upgrades to take place for a limited period of time.

Most of the consent configuration is automatically moved to the Consent add-on's own configuration (in Lime Admin). Only the GDPR specific consent configuration is kept in the GDPR configuration.