Requirements¶
Lime CRM Server¶
- On-premise:
- Lime CRM Server: 2024.1 or later.
* Possible although not recommended: 2023.2 if you lock lime-bi dependency to strictly less than 3.46.7.
* Possible although not recommended: 2023.1 if you lock lime-bi dependency to strictly less than 3.46.2.
* Possible although not recommended: 2022.3 if you lock lime-bi dependency to strictly less than 3.46.0.
* Possible although not recommended: 2022.2 if you lock lime-bi dependency to strictly less than 3.38.4.
* Possible although not recommended: 2021.1 if you lock lime-bi dependency to strictly less than 3.24.0.
- Outgoing internet access.
- Cloud:
- Included in Solution Cloud Shared.
- Isolated application using lime-crm 2.744.0 or later.
Lime Bootstrap in Desktop client¶
If you want to show a Lime BI dashboard in the desktop client you need Lime Bootstrap 1.12 or higher (1.x)
Additional On-premise Requirements¶
Metabase Versions¶
When installing the service via the command, it will download the latest version of the Metabase package. Here is an overview of what lime-bi version you need in order to run which Metabase version:
- lime-bi < 3.32.0: support for Metabase 1.34.x
- lime-bi >= 3.32.0: support for Metabase 1.41.x
- lime-bi >= 3.40.0 support for Metabase 1.44.x
- lime-bi >= 3.46.0 support for Metabase 1.46.x
- lime-bi >= 3.49.0 support for Metabase 1.47.x
- lime-bi >= 3.53.0 support for Metabase 1.49.x
- lime-bi >= 3.54.0 support for Metabase 1.50.x
PostgreSQL Database¶
Lime BI uses a postgres database to store information about saved questions, dashboards, and any other data needed to run the application.
Enable TCP/IP Connections in the Microsoft SQL Server¶
Lime BI uses TCP/IP to connect to the Lime database. Many SQL Servers installation does not have that enabled by default.
Open Port 1433 in Microsoft SQL Server¶
Lime BI connects to Microsoft SQL Server on port 1433. You have to ensure that the port is open.
Outgoing Internet Access¶
When Lime Bi boots up it will verify the license by sending a request to https://store.metabase.com/api
or https://token-check.metabase.com
. These requests have to be allowed by the network so that premium features like the white labeling can be activated.
To verify which of the domains is used, open the Lime BI admin panel and go to Settings -> License and Billing. Make sure the license key is entered and click "Activate". If the network is blocking the request, you will see an error message. Go to Troubleshooting -> Logs and scroll to the bottom to see the details of that message. It should state there which of the domains it called for the verification. Contact the customer's IT to temporarily open the domain in the firewall. Click "Activate" again and it should successfully validate the license.
The validation happens always when the service starts, therefore the license can be invalidated if the service is restarted and the domain is blocked again.