Service: Suite CRM - EyevinnOSC/community GitHub Wiki

SuiteCRM

SuiteCRM (serviceId salesagility-suitecrm) is an open source Customer Relationship Management (CRM) platform built on top of SugarCRM, as a self-hosted package. In Eyevinn Open Source Cloud (OSC) it is a long-running service instance with up to 10 GiB of storage per instance. License: AGPL-3.0. Source: salesagility/SuiteCRM.

What it can do

  • Manage contacts, accounts, leads and opportunities, and track the sales pipeline.
  • Run email and newsletter campaigns.
  • Handle support cases and project management.
  • Build reports and data exports.

Creating an instance

Call create-service-instance with serviceId: "salesagility-suitecrm". The instance name must be alphanumeric and at most 20 characters. SuiteCRM bundles its own database, so no other OSC service is needed.

{ "name": "mycrm" }

Wait with wait-for-service-ready (or get-instance-status); the first startup takes a minute or two while the database initialises. Read the URL with describe-service-instance.

Options

Option Required Type Meaning
name Yes string Name of the instance. Alphanumeric/underscore only, at most 20 characters.

The service has no other options and no secrets.

Using the instance

Complete the web installer

Open the instance URL to start the SuiteCRM web installer:

  1. Accept the license agreement.
  2. Review the system requirements check; all items should be green.
  3. Enter database details. SuiteCRM bundles a database automatically, so accept the default values.
  4. Create the admin account with a username and a strong password.
  5. Complete the installer and wait for the "Installation Complete" screen.

Then log in at the instance URL with the admin credentials. The dashboard shows modules in the top navigation bar.

Key modules

Module What it does
Accounts Companies and organisations you do business with
Contacts Individual people linked to accounts
Leads Prospective customers not yet converted
Opportunities Deals in progress with stage and close date
Cases Support tickets linked to accounts
Campaigns Email and newsletter campaigns
Reports Custom dashboards and data exports

CLI usage

osc create salesagility-suitecrm mycrm

Resources