SuiteCRM Installation Guide



SuiteCRM is a popular open-source customer relationship management (CRM) software. Its main features include sales force automation, marketing campaigns, support cases, and calendaring.

SuiteCRM is free

SuiteCRM is released under the Affero General Public License (AGPL). It means that it is free to download and use. But, if you make any changes to the code, you must share these changes with the community.

Suppose you’re looking for an easy-to-use CRM system with plenty of features. Then SuiteCRM could be a good option.

SuiteCRM  offers free versions of their software. However the paid versions  have some different features.

Why choose SuiteCRM?

  • It provides a 360-degree view to know all about your customer
  • It acts as a central repository and gives key insights into your customer data to improve the business relationship
  • It provides complete freedom to customize your CRM as it is Open-source.
  • It provides an open Rest API that allows you to integrate with the core business. With this, you can collaborate across boundaries.

We will explain the following steps in this guide

  • 1. How to install the SuiteCRM latest version
  • 2. How-to tips for using SuiteCRM

How to Install

To install SuiteCRM, you will need to meet the minimum system requirements.

The Minimum System Requirements

– A web server with PHP 5.4 or later installed 

– A database server like MySQL, MariaDB, or PostgreSQL 

– The Apache mod_rewrite module enabled 

– Apache – 2.2, 2.4

Other Requirements

  • PHP
  • JSON
  • XML Parsing
  • MB Strings Module
  • Writable SugarCRM Configuration File (config.php)
  • Writeable Custom Directory
  • Writable Modules Sub-Directories and Files
  • Writable Upload Directory
  • Writable Data Sub-Directories
  • Writable Cache Sub-Directories
  • PHP Memory Limit (at least 128M)
  • ZLIB Compression Module
  • ZIP Handling Module
  • PCRE Library
  • IMAP Module
  • cURL Module
  • Upload File Size( Minimum 10 MB)
  • Sprite Support

If these requirements are satisfied, you can proceed with the next step. What is that? 

Before downloading SuiteCRM in Windows, it is important to install WAMP or XAMPP.

Reason to install WAMP or XAMPP

To test your site on the local server before publishing it to the real server is the most important thing. In order to do so, installing the WAMP and XAMPP is good practice. 

This  local web server makes you free from learning and remembering the toughest coding and commands of PHP, MySQL and more. You have to run the control panel of that web server. And that’s it .Using the control panel you can manage all the inclusive components. For the beginners it is important to understand the significance of WAMP and XAMPP. 

WAMP is a significantly used platform as it was specifically designed only for Windows users. However XAMPP is also having equal functionality as WAMP. And it can be used for Windows, LINUX and Mac OS as well. You can choose any platform depending on your objectives.


Have you complete installing WAMP or XAMPP?


Then what next? Are you ready to install SuiteCRM. Before installing SuiteCRM make a check  over the pre-installation requirements of your system. This was explained above in this guide. Verify whether you have an updated version of PHP. And also check the XAMPP version and PHP version are mutually oriented.   Come on. Let’s begin

The XAMPP installation was completed successfully. Then what next? Are you ready to install SuiteCRM. Before installing SuiteCRM make a check  over the pre-installation requirements of your system.

This was explained above in this guide. Verify whether you have an updated version of PHP. And also check the XAMPP version and PHP version are mutually oriented.   Come on, Let’s begin.

Steps to download SuiteCRM

Step 1

After installing XAMPP or WAMP, you can proceed with downloading the latest version of SuiteCRM ( from the official website.

Be sure to choose the “Community Edition” option.

Register with the SuiteCRM and download the SuiteCRM zip File

(You can Proceed to Log in if you are an existing User)

Step 2

You can find the Zip folder in your “Downloads” folder.

Once you download the zip file, unzip or extract the file

Step 3

And Copy all the extracted files of SuiteCRM.

Step 4

Then Go to the XAMPP folder (from the location you have download the XAMPP).

Step 5

Click on the xampp file.There you can find a folder called htdocs. Go through the folder.

Step 6

On the htdocs folder, you should create a new folder as SuiteCRM

Paste all the files that you copy before(i.e all the extracted suitecrm file) in this new folder

Step 7

Now open the XAMPP control panel

Step 8

Click “Start” on the corresponding Apache and MySQL

Step 9

Wait until the number for PID(s) and port to appear(i.e the status of Apache and MySQL to turns green)

Then minimize the control panel  screen.


Don’t forget to run the XAMPP control panel. Unless the SuiteCRM can’t be installed.

Now you have minimized your XAMPP control panel screen. Right?

Then Open your web browser

Go to the address bar and enter localhost/SuiteCRM.(this name SuiteCRM is the name of the folder where we paste the extracted files of SuiteCRM

Then you need to change the ownership of the SuiteCRM directory to Apache user and groups.

The operating system decides the features of the system user. That is, the system user of your web server varies depending on your operating system. The commonly used web server includes:

– Apache(Linux/Apache)

– IUSR_ComputerName(Windows/IIS)

If you are using Linux, then set the below-mentioned permission on your SuiteCRM directory:

custom modules themes data upload config_override.php. ( To make your folder writable 775 is used)

sudo chown -R www-data:www-data
sudo chmod -R 755
sudo chmod -R 755 cache

Now you have completed the downloading process of SuiteCRM. Next, we will learn the Installation Process.

Installation Process of SuiteCRM

The localhost/suitecrm redirects you to the installation page. 

Other wise you can open your browser and then go to SuiteCRM.

SuiteCRM redirects you to the installation page if you have already installed the file.

(If you are new to installing the SuiteCRM, then it redirects you to the Login page)

Installation Page

Step 1

On the installation page, you will find the License Agreement. That is GNU Affero General Public License..

Accept the License Agreement.Then Click Next

SuiteCRM setup wizard-SuiteCRM Installation

Step 2

SuiteCRM verifies all the prerequisites of the server to make sure that the file runs correctly.

If you find any error, then it needs to be resolved. So that the functionalities of your module work.

If you have no errors, then click Next.

Checking environment- SuiteCRM installation
system environment-SuiteCRM installation

You will move to the configuration page now.

Creating a Database

Before entering into this configuration you have to create a database first. It is the better option to create the database once you run the XAMPP control panel. Don’t be confused about how to  create database. Here are the few easy steps to create a database.

Open localhost on the address bar

On the next tab Open http://localhost/phpmyadmin/

The phpMyAdmin page will open

Click on “Create Database” on the database section.

You have to enter the name of the database as suitecrm and select the language.

Click “Create”

A new database was created with a name suitecrm.

Now come into the installation process of SuiteCRM

Configuration Page

The configuration page includes database configuration and site configuration the following.

Configuration page- SuiteCRM installation

Database Configuration

– Enter the Database type(Select MySQL)

– Hostname: You must type the database server hostname in this field. (by default, it is set as localhost)

– Database name( The default name is suitecrm(it is the name of the database that we have created before in phpMyAdmin) CRM. You can also create a custom name)

– User name (user name having database access. (By default, it is set as root )

– Password(Not needed for MySql. You may leave this section empty)

Site Configuration

Enter the login user name in “SuiteCRM Application Admin Name.” (Name of the administrator account).

Enter the administrator account’s password in “SuiteCRM Admin User Password.” Then re-enter the password for confirmation.

In “URL of SuiteCRM instance,” enter the URL path to SuiteCRM was appear. It was entered as default.

In “Email address,” enter the administrator’s email address.


It is only mandatory to provide required information in Database configuration and Site configuration.

The more options section is optional. You may fill it now or leave it for later. That is up to your choice.

If you want to skip the more option section then Click “Next” icon at the bottom of the page. And move to Step 7

If not then proceed with Step 6.

More Options Section (Optional)
What is in the More Option Section?

The More option section includes SMTP server specifications, Branding and Logo, System and Locale Setting and Site Security.

Enter the full details of your SMTP server in the “SMTP Server Specifications” section

SMTP- SuiteCRM installation

Insert your company logo and brand in the “Branding and Logo” section

Branding- SuiteCRM installation

Set your organization’s date, time zone, and currency in the “System Locale Settings section. Modify these values based on regular users.

System locale- SuiteCRM installation

Installation Page

The installation screen checks the credentials specified by the administrator. If the database name already exists, then a dialog box will appear. That shows whether to change the database name or to accept the database name. 


The database tables are dropped if you use the existing database name. Then click Accept to drop the current database table.


Or click “Cancel.” And specify a new database name.


Now SuiteCRM starts Installing.

install-SuiteCRM installation

Installation Complete

After installation, it will lead you to the login page.

On the login page, enter your username and password (you have set them in the site configuration)

login page- SuiteCRM installation

Now the SuiteCRM dashboard will open.

Dashboard- SuiteCRM installation

You have successfully installed the SuiteCRM. Then waiting for what? Start working with your SuiteCRM.

Install and Set up Your SuiteCRM in 2 Hours.

Customize the CRM for your needs

If you are new to SuiteCRM you have to learn some modules and the management of SuiteCRM. Let us discuss about that, to improve our knowledge on SuiteCRM.


Under the administration section, options like user management and the system settings are available. The administrator can change the SMTP email server, add users or view logs, and different configuring options as below.

User Management

  • In this section, you can manage the user name, and password as well as all the user details
  • In the user list view, you will see the Administrator User(by default)
  • You can create the user by clicking the "Create User" icon
  • Fill in all the required fields to create a user.
  • For each user, you can set a theme. SuiteCRM has three themes by default.
  • Configure the basic user settings. That includes
  • Set email notification for assigning a new record for that user
  • Set date, time, and currency settings for the user
  • Display only required modules of that user
  • After completing this, the user will get an email notification to set a password. Now the user creation is complete.
  • Then the Admin will set up a role for the user. You can view the Role management under the sub-menu of the Admin section.

System Settings

The system settings include

-User Interface

-Branding and Logo of your organization

-Number of records to be displayed in the list view

Advanced Settings

-You can change ON/OFF of the developer mode

-Log configuration, which includes slow log time taking queries

Logger Settings

-Change the name and size of the Log.

-Select the level of the Log

-You can also refer to the Official guide for detailed instruction.

-Once installation steps are completed, you can begin using SuiteCRM! Be sure to explore all its features and familiarize yourself.

How to clear the cache

After the installation, if you want to clear the cache in SuiteCRM, there are a few steps you need to follow.

First, log into your SuiteCRM account by entering localhost/SuiteCRM on your browser.

The SuiteCRM dashboard will open

Click the icon “admin” on the top right corner of the page. And click “Admin” on the submenu.

admin page- SuiteCRM installation

The Administration page will open. Scroll down until you find Admin tools.

On the Admin tools section Click on the “Repair and Rebuild”

repair- SuiteCRM installation

Now you are entered into the Repair Window. Click “Quick Repair and Rebuild”

Quick repair and rebuild- SuiteCRM installation

Then it starts clearing cache and rebuilt extensions & tables.

After clearing the cache files you can go to the administration page by clicking “Return to Administration page” which is at bottom of that clear cache window.

return to admin page- SuiteCRM

It will ensure that all cached data is removed from your SuiteCRM account. And that your system is up-to-date.

How to add a field

Adding fields in SuiteCRM is a simple process, completed in just a few steps.

Step 1

To add a field, login to your SuiteCRM account and navigate to the “Admin” section.

Click “Admin” on the submenu of “admin”(top right corner of the page)

Step 2

The administration page will open. Scroll down on the administration page to find developer tools. On the developer tools, Click “Studio”.

Studio- SuiteCRM installation

Step 3

The Studio section contains Export customization icon and the Modules to edit

You can add fields to any of modules that you need to add

Select the modules to which you need to add fields

For example. Select the module invoices

invoice- SuiteCRM installation
Step 4 Then click on the “Add fields” icon
add field- SuiteCRM installation

Step 5

In the “Add Field” popup window, you will need to enter the following information:

Data type: Select the datatype of the new field. The datatype you selected determines what type of character need to be entered for the new field. For example, If you need to enter only numbers in the new field, then select integer datatype.

Choose the data type of field you wish to add from the dropdown list. The most common types are text, number, and date.

Field Name: Enter the name of your new field here. This name will be displayed in the field list and on any forms where the field appears.

Help Text: The help text appears temporarily while a user hovers over the field. And it can be used to prompt the user for the type of input desired.

Comment Text: It is seen only in the module builder and the Studio tab. It can be used to describe the field for administrator.

Default Value: If a new record generated, then the default value will be pre populated in the field. You can use the default value or you can enter the new value as you wish.

Max Size: It determines the maximum number of characters entered in the field.

Required: Enable the checkbox if you required the field. Unless leave it as disable. You should provide a value to save the records of the field.

Audit: Enable the checkbox to track changes to the field in the Change log.

Importable: Select Yes on the drop down box of importable will allow, disallow or require the field to be imported into the Import Wizard.

Duplicate Merge: You can enable or disable this Duplicate Merge  field to find the duplicate features.

Step 6

Click the “Save” button to add the new field.

save field- SuiteCRM installation

Creating Custom Module: A How-To Guide for SuiteCRM Developers

If you’re a developer working with SuiteCRM, you may need to create a custom module.

We explain the steps to create a basic custom module in SuiteCRM. Creating a custom module is quite simple in SuiteCRM with this easy steps.

Go to the administration page by clicking admin<<Admin

On the administration page scroll down for the Development tools. And then click “Module builder” on it

On the Module Builder page click “New package” icon

Then a new package window will appear.

Module buider- SuiteCRM installation
new package- SuiteCRM Installation

On that new package window you have to enter:

Package Name: The name should be alphanumeric. Starts only with letters. And the package name should not contains spaces.

Author name: You should provide the author name of the packages.

Key : Use only alpha numeric key.

Click “Save”.

suitecrm mailchimp- SuiteCRM installation
SuiteCRM- SuiteCRM installation

Now the Mailchimp module is available near the new package icon.

Then you can Export the new module created by clicking “Export”.

Your file will be exported successfully and saved as a zip folder on your downloads.

Thus you can downloaded the custom module.For installing the custom module you have to follow the instructions.

How to install Custom modules in SuiteCRM?

Installing the custom modules on the developer portal site of SuiteCRM is easy. Before learning the installation process, you need to know: Are there any modules unsupported?

Yes. Following are the unsupported modules. And the installation is blocked on the developer Portal.

  • backup_migrate
  • content_sync
  • delete_all
  • devel_themer
  • domain
  • php
  • simple HTML mail
  • swift mailer
  • theme_editor

Now we will learn how to install custom modules in SuiteCRM.

Go to the administration page.  Scroll down to the bottom, where you find

“Admin Tools”.

Click “Module Loader” on the Admin Tools

On the Module Loader page Click “Install” icon near the package name

And that’s all you have successfully installed the custom module

You can also delete the package by clicking “Delete package”. If you delete the package, then it will be disappear from the new package section

How to uninstall SuiteCRM?

First, go to the directory where SuiteCRM is located.

For Windows:

From your database server, delete the database schema. As we already said, the default database name is suitecrm. But it may vary if you change the database name during installation.


First, remove the SuiteCRM directory. Use the following command:

rm -rf – To delete the directory

We are the end of the guide. So far we have learned a detailed explanation of SuiteCRM installation. And of course you have learned how to handle SuiteCRM. It is very simple to install the basic custom module in your SuiteCRM.

Though there are many more that includes integration of mail, google calendar, Duplicate merger and the lists goes on. Don’t worry about that. We provide customization for these exclusive extensions of SuiteCRM that meets your business needs. Our custom modules will definitely helps you increase you sales growth and business efficiency

You can get our custom modules for SuiteCRM.

We also provide customization service for SuiteCRM based on your request. If you need our support or service you can contact us at [email protected]

Check Our SuiteCRM Extensions Collection to Improve Productivity.

Cookies help us deliver our services. By using our services, you agree to our use of cookies.