Skip to content

Installation Instructions

Preparations

  • Check that the requirements are met.
  • Make sure the Lime CRM backend is reachable over HTTPS from the users' browsers.

Installation

  1. Install the package in your solution (poetry add limepkg-mail-addin) and deploy it.
  2. Configure the add-in in Lime Admin → Mail Addin. At a minimum, set the base URL, pick a limetype, and map the email fields. See Configuration for all options.
  3. Download the manifest (manifest.xml) from the Install Outlook Add-in section in Lime Admin.
  4. Install the add-in in Outlook for each user:
    • Open Outlook Add-ins and go to My Add-ins.
    • Click Add a custom add-in → Add from file and upload the manifest.xml.
    • Reload Outlook. The Lime CRM button appears in the ribbon when an email is open.

Central Deployment

For a larger rollout, an admin can deploy the manifest.xml centrally instead of having each user sideload it. See Microsoft's deployment guide for the available options.