Skip to main content

Installation

This guide walks you through installing the SaaS Module on your Perfex CRM. It's straightforward - just follow each step carefully.

info

Prerequisites: Make sure you've completed the Requirements checklist before starting this installation.

Watch the Installation Videoโ€‹

Prefer watching over reading? Here's a complete video walkthrough:

Step 1: Download the Moduleโ€‹

  1. Go to CodeCanyon and find "SaaS Module for Perfex CRM" in your downloads
  2. Click the Download button
  3. Choose "Installable File Only" (this gives you just the module zip file)
  4. Save the .zip file to your computer
warning

Important: Download the "Installable File Only" option - NOT "All files & documentation." The installable file is the one you'll upload to Perfex CRM.

Step 2: Upload to Perfex CRMโ€‹

There are two ways to upload the module. Choose whichever is easier for you:

This is the easiest method:

  1. Log in to your Perfex CRM Admin Panel
  2. Go to Setup (in the left sidebar)
  3. Click on Modules
  4. Click the Upload Module button (top right corner)
  5. Select the .zip file you downloaded in Step 1
  6. Click Upload
  7. Wait for the upload to complete (this may take a moment depending on your server speed)

Option B: Upload via FTP/SFTPโ€‹

If the admin panel upload doesn't work (some servers have upload size limits), use this method:

  1. Extract the .zip file on your computer
  2. Connect to your server using an FTP client (like FileZilla - it's free)
  3. Navigate to your Perfex CRM directory: your-perfex-folder/modules/
  4. Upload the extracted module folder into the modules/ directory
  5. The final path should look like: your-perfex-folder/modules/saas/
info

What's FileZilla? It's a free program that lets you upload files to your web server. Think of it like a file manager for your website. Download it from filezilla-project.org.

Step 3: Activate the Moduleโ€‹

After uploading, you need to activate the module:

  1. In your Perfex CRM Admin Panel, go to Setup โ†’ Modules
  2. You should see "SaaS Module" in the list of available modules
  3. Click the Activate button next to it
  4. The page will reload - this means the module is now active!

After activation, you'll notice a new menu item in your left sidebar: SaaS Management. This is your command center for everything SaaS-related.

SaaS Management menu and settings After activation, the SaaS Management menu appears in your sidebar with all configuration options

Step 4: Enter Your Purchase Codeโ€‹

  1. Go to SaaS Management โ†’ SuperAdmin Settings
  2. Enter your CodeCanyon Purchase Code
  3. Click Verify or Save
info

Where to find your purchase code: Go to codecanyon.net/downloads, find the SaaS module, click the Download dropdown, and select "License Certificate & Purchase Code." The purchase code is in the text file that downloads.

Step 5: Configure MySQL Server Settingsโ€‹

This is the most important configuration step. The module needs MySQL credentials to create databases for your tenants.

  1. Go to SaaS Management โ†’ SuperAdmin Settings
  2. Click the MySQL Server Settings tab
  3. Fill in the following fields:
FieldWhat to EnterExample
Database for Each TenantSelect Yes for isolated databases (recommended) or No for shared databaseYes
Use Subdir StructureSelect Yes if you want yoursite.com/ws/tenant-name URLsYes
I have cPanelSelect Yes if your server uses cPanel, No if notDepends on your hosting
MySQL HostUsually localhostlocalhost
MySQL PortUsually 33063306
MySQL Root UsernameYour MySQL username with CREATE DATABASE privilegeroot
MySQL PasswordThe password for the MySQL user aboveyour-password

MySQL Server Settings configuration MySQL Server Settings - fill in your database connection details here

  1. Click "Click here to verify server settings" - this tests your MySQL connection
  2. If verification succeeds, click Save Settings
danger

Verification failed? This usually means:

  • The MySQL username or password is wrong
  • The MySQL user doesn't have CREATE DATABASE privileges
  • MySQL is not running on the host/port you specified

Double-check your credentials and try again. See Troubleshooting โ†’ Installation Issues for detailed fixes.

Step 6: Verify Everything Worksโ€‹

Let's make sure everything is set up correctly:

  1. Go to SaaS Management โ†’ Plans
  2. Try creating a test plan (you can delete it later)
  3. Go to your site's landing page URL and see if the registration form appears

If all three checks pass - congratulations! The module is installed and working!

What's Next?โ€‹

Now that the module is installed, you need to configure it for your business:

  1. Configure DNS & Domains - Set up how tenant URLs will work
  2. Set up your SaaS Settings - Configure tenant settings, plans, and landing page
  3. Create your first plan - Set up pricing and features
tip

Installation complete! You're now running a multi-tenant SaaS platform. Continue to the next guides to customize everything for your business.