Lime CRM Server Upgrade Guide

This page describes how to upgrade an existing Lime CRM Server installation. The upgrade procedure might differ, depending on the version of Lime CRM Server that is currently installed.

Follow these steps:

1. Perform pre-upgrade preparations.
2. Depending on which version is currently installed, see if there are some extra upgrade steps needed.
3. Upgrade and build a new release of the solution.
4. Back-up the database.
5. Do the steps in this guide: Uninstall Erlang and RabbitMQ When Doing Lime CRM Server Upgrade
6. Restart the Windows server.
7. Run the installer (limecrm-server-<version>.exe) as administrator.
8. Restart the Windows server.
9. Upgrade all registered databases.
10. Install upgraded solution.
11. Re-enable Super Search if it was in use earlier.
12. Create or update search index (needed if the customer uses the Web Client).
13. Verify that the upgrade has succeeded. E.g. test some basic functionality and important solution customizations.

If the upgrade fails or something doesn't work as expected, check out the Troubleshoot Server Installation/Upgrades guide.

The pre-upgrade preparations should be performed several days ahead of the actual server upgrade. Follow these steps to ensure that you're upgrade is successful:

The server requirements gets updated on a regular basis. Go to the server requirements page to make sure your customers server is still up to date.

The installer application remembers the installation configuration (e.g. user and group information) specified from the last time it was run. However, no passwords are remembered. So make sure you know the password for the Lime CRM Server user account (a.k.a. Lime service user).

Read up on the release notes for the server version you are upgrading to, and all the server versions you may be jumping over.

Go through all the add-ons that are installed in the Lime CRM application. Check their documentation and see if there are new versions that could or MUST be installed. There are mainly two good reasons to also upgrade installed add-ons:

• The version that is installed for an add-on may not work anymore if the server is upgraded.
• Doing a server upgrade is the perfect time to also make sure the add-ons are up to date so the customer can enjoy the latest and greatest version of the Lime CRM software.

Check if Super Search is enabled in Lisa.

1. Open cmd/terminal/windows powershell (not Lime Pro Command Prompt).
2. Write ‘python -V’ and press enter key to see Python version.
3. If not using latest compatible version. Run the Python installer and click “Upgrade Now”.

When upgrading from some versions there are extra steps needed to complete the upgrade.

Python 3.11 is required from version 2023.1 and later of Lime CRM server. Follow the instructions here before running the installer. If 3.11 isn't available the Lime CRM installer will detect this and stop.

.NET 4.7.2 or later is required to run Lime CRM. Recommendation is to run 4.8. You can check which version is running by following the instructions here. Install the runtime version before running the installer from here if you have a older version. If 4.7.2 or later isn't available the Lime CRM installer will detect this and stop.

Check SQL Server version SQL Server 2014 or later is required, Lime CRM 2023.1 will not work on SQL Server 2012

Remove the Elastic Search 5 data directory. Prior to creating a new search index, it is necessary to manually delete the previous data directory associated with ElasticSearch 5 (%LIME_HOME_PATH%\LIME Pro Server\Elasticsearch\data). Otherwise, old indexes built for ElasticSearch 5 will remain on the server and take up disk space and interfer with the new installation.

Create a new search index. You have to create a new search index with help of the command limefu search index. Remember that this is an operation that can take very long if the database associated with the solution contains lots of data.

Tips for the web client when upgrading

• The new start page is turned on by default. Make sure it looks good and that all widgets (especially info tiles) have been moved to the new start page. How to configure the start page.
• Over delivery: Add multiple start pages if you think your customer needs them.
• Over delivery: Remove unnecessary fields from create new dialogs. Calculated fields, read only field, “inactive” and more do not provide any value when creating new records. Take a minute or two to disable them on new in the card view of the most common lime type.
• Over delivery: Does you customer have a lime type that hold hundreds of thousands or even millions of records? Is there no need to have that lime type searchable? Disable indexing for certain lime types to make the index much smaller and reduce re-index time.

Erlang and RabbitMQ Needs To Be Manually Uninstalled

Erlang and RabbitMQ needs to be manually uninstalled to get upgraded correctly by the Lime CRM installer. Follow this guide: Uninstall Erlang and RabbitMQ When Doing Lime CRM Server Upgrade

• Server version 2022.2.739 (2.308.3) and higher requires Lime CRM Desktop Client version of 10.18.962 or higher

In older server versions, the packages for the GDPR, Consent, Newsletter and Info Tiles (WC) were included in the server installation. Make sure to check these specifically if you are upgrading from a server version older than 2020.2.

From version 12.51 and later of Lime CRM Server, Python needs to be installed prior to installation or upgrade of Lime CRM Server.

Instructions for how to install Python is found here.

From Lime CRM Server 12.9, lime-views and some configuration is stored in the database instead of in files. To migrate existing lime-views and configurations, run the following script from the Lime CRM Command Prompt on the server.

python migrate_config.py <database name>

migrate_config.zip

From Lime CRM Server 12.6, the file-API makes it possible to include the name of the document-file as a proper filename. When upgrading, already existing files do not have any filename, and if you want to set the filenames on the already existing files you need to run the following SQL-script. The script set the filename to the text in the field [description] on the document-table, but can be adjusted to suit the individual solution.

filename-migration-lime.zip