/home/edulekha/crm.edulekha.com/documentation/index.html
<!DOCTYPE html>
<!--[if IE 6 ]>
<html lang="en-us" class="ie6">
<![endif]-->
<!--[if IE 7 ]>
<html lang="en-us" class="ie7">
<![endif]-->
<!--[if IE 8 ]>
<html lang="en-us" class="ie8">
<![endif]-->
<!--[if (gt IE 7)|!(IE)]><!-->
<html lang="en-us">
<!--<![endif]-->
<head>
<meta charset="utf-8">
<title>
Perfex - Powerful Open Source CRM
</title>
<meta content="" name="description">
<meta content="MSTdev" name="author">
<meta content="MSTdev" name="copyright">
<link href="assets/images/favicon.ico" rel="shortcut icon">
<link href="assets/css/documenter_style.css" media="all" rel="stylesheet">
<script src="assets/js/jquery.js"></script>
<script src="assets/js/jquery.scrollTo.js"></script>
<script src="assets/js/jquery.easing.js"></script>
<script>
document.createElement('section');
var duration = '598',
easing = 'swing';
</script>
<script src="assets/js/script.js"></script>
<style>
html {
background-color: #ffffff;
color: #383838;
font-size: 15.5px;
}
#documenter_sidebar #documenter_logo {
background-image: url('assets/images/logo.png');
}
#documenter_content h1 {
font-size: 28px;
}
a {
color: #0488c7;
}
.btn {
border-radius: 3px;
}
.btn-primary {
background-image: -moz-linear-gradient(top, #008C9E, #006673);
background-image: -ms-linear-gradient(top, #008C9E, #006673);
background-image: -webkit-gradient(linear, 0 0, 0 008C9E%, from(#343838), to(#006673));
background-image: -webkit-linear-gradient(top, #008C9E, #006673);
background-image: -o-linear-gradient(top, #008C9E, #006673);
background-image: linear-gradient(top, #008C9E, #006673);
filter: progid: DXImageTransform.Microsoft.gradient(startColorstr='#008C9E', endColorstr='#006673', GradientType=0);
border-color: #006673 #006673 #bfbfbf;
color: #FFFFFF;
}
.btn-primary:hover,
.btn-primary:active,
.btn-primary.active,
.btn-primary.disabled,
.btn-primary[disabled] {
border-color: #008C9E #008C9E #bfbfbf;
background-color: #006673;
}
pre {
box-sizing: border-box;
overflow: auto;
font-family: Menlo, Monaco, Consolas, 'Courier New', monospace;
font-size: 13px;
padding: 9.5px;
margin-top: 0px;
margin-bottom: 10px;
line-height: 1.42857;
color: rgb(51, 51, 51);
word-break: break-all;
word-wrap: break-word;
border-color: rgb(204, 204, 204);
border-radius: 4px;
background-color: rgb(245, 245, 245);
}
hr {
border-top: 1px solid #D4D4D4;
border-bottom: 1px solid #FFFFFF;
}
#documenter_sidebar,
#documenter_sidebar ul a {
background-color: #343838;
color: #FFFFFF;
}
#documenter_sidebar ul a {
-webkit-text-shadow: 1px 1px 0px #494F4F;
-moz-text-shadow: 1px 1px 0px #494F4F;
text-shadow: 1px 1px 0px #494F4F;
}
#documenter_sidebar ul {
border-top: 1px solid #212424;
}
#documenter_sidebar ul a {
border-top: 1px solid #494F4F;
border-bottom: 1px solid #212424;
color: #FFFFFF;
}
#documenter_sidebar ul a:hover {
background: #333636;
color: #00DFFC;
border-top: 1px solid #333636;
}
#documenter_sidebar ul a.current {
background: #333636;
color: #00DFFC;
border-top: 1px solid #333636;
}
#documenter_copyright {
display: block !important;
visibility: visible !important;
}
</style>
</head>
<body class="documenter-project-perfex-powerful-open-source-crm">
<div id="documenter_sidebar">
<a href="https://www.perfexcrm.com" id="documenter_logo">
</a>
<ul id="documenter_nav">
<li>
<a class="current" href="#introduction" title="Welcome">Introduction</a>
</li>
<li>
<a href="#system_requirements" title="System Requirements">System
Requirements</a>
</li>
<li>
<a href="#installation" title="Installation">Installation</a>
</li>
<li>
<a href="#setup" title="Setup">Setup</a>
</li>
<li>
<a href="#faq" title="FAQ">FAQ</a>
</li>
<li>
<a href="#update" title="Update">Update</a>
</li>
</ul>
<div id="documenter_copyright">
Copyright MSTdev
<br> made with the <a href="http://rxa.li/documenter">Documenter v2.0</a>
</div>
</div>
<div id="documenter_content">
<section id="introduction" style="margin-top:-25px;">
<div class="page-header">
<h1>
Perfex - Powerful Open Source CRM
</h1>
<hr>
</div>
<h4>Documentation Info</h4>
<ul>
<li>
<b>Last Updated</b>: 2024-11-05
</li>
<li>
<b>Created by</b>: <a href="https://codecanyon.net/user/mstdev">MSTdev</a>
</li>
<li>
<b>Version 3.4.0</b>
</li>
<li>
<b>Website:</b> <a href="https://www.perfexcrm.com/">www.perfexcrm.com</a>
</li>
<li>
<a href="https://help.perfexcrm.com/"><strong>Full Documentation</strong></a>
</li>
<li>
<a href="https://my.perfexcrm.com/"><strong>Support Desk</strong></a>
</li>
</ul>
<hr />
</section>
<section id="system_requirements">
<div class="page-header">
<h4>
<strong>System Requirements</strong>
</h4>
<hr class="notop">
</div>
<ul>
<li style="box-sizing: border-box;">
PHP >= 8.1+
</li>
<li style="box-sizing: border-box;">
MySQL 5.1+
</li>
<li style="box-sizing: border-box;">
mod_rewrite Apache
</li>
<li style="box-sizing: border-box;">
MySQLi PHP Extension
</li>
<li style="box-sizing: border-box;">
PDO PHP Extension
</li>
<li style="box-sizing: border-box;">
cURL PHP Extension
</li>
<li style="box-sizing: border-box;">
OpenSSL PHP Extension
</li>
<li style="box-sizing: border-box;">
MBString PHP Extension
</li>
<li style="box-sizing: border-box;">
iconv PHP Extension
</li>
<li style="box-sizing: border-box;">
IMAP PHP Extension
</li>
<li style="box-sizing: border-box;">
GD PHP Extension
</li>
<li style="box-sizing: border-box;">
Zip PHP Extension
</li>
<li style="box-sizing: border-box;">
allow_url_fopen enabled
</li>
</ul>
<p>
In most hosting accounts these extensions are enabled by default. But you should consult with your hosting provider.
</p>
</section>
<section id="installation">
<div class="page-header">
<h3>
<strong>Installation</strong>
</h3>
<h4>Check this <a href="https://help.perfexcrm.com/quick-installation-getting-started-tutorial/" target="_blank">Quick Installation & Getting Started Tutorial</a></h4>
<hr class="notop">
</div>
<iframe src="https://player.vimeo.com/video/171576957" width="640" height="331" frameborder="0" webkitallowfullscreen mozallowfullscreen allowfullscreen></iframe>
<h5>
<strong>Configure database connection</strong>
</h5>
<p>
Login to cPanel and create a brand new database that will be used for Perfex CRM installation.
</p>
<p>
You can check this tutorial <a href="https://www.namecheap.com/support/knowledgebase/article.aspx/9363/2180/how-to-create-and-maintain-mysql-databases-in-cpanel" target="_blank">how to setup MySQL database in cPanel</a> if you are not familiar with how to configure database.
</p>
<ol>
<li>Login to cPanel by accessing www.yourdomain.com/cpanel and navigate go MySQL Databases, note that this step may vary and in some hosting providers can be different.
</li>
<li>Create database.
</li>
<li>Create user and set up user password. (write in a note username and password because needs to be re-used later)
</li>
<li>Add the user to the database by selecting the database and the username.
</li>
<li>
Make sure you have checked <b>All privileges</b> when adding the user to the database.
</li>
</ol>
<hr>
<h5>
<strong>Upload Files & Install</strong>
</h5>
<p>
Upload the files to server folder where Perfex CRM will be installed.
</p>
<p>
Assume that you uploaded the files to “crm” folder, navigate to eq. http://yourdomain.com/crm/install – Keep in mind that you need to adjust the URL based on where you uploaded the files. If you are installing on subdomain named eq crm you need to access the url like http://crm.yourdomain.com/install.
</p>
<p class="note">
<strong>You will need to pass the requirements to install Perfex CRM.</strong>
</p>
<p>
<img alt="" src="assets/images/image_4.png">
<br> If all server requirements passed click <b>Go to Files/Folders Permissions</b> otherwise consult with your hosting provider to fix/enable them.
</p>
<p>
<img alt="" src="assets/images/image_8.png">
<br />If all permissions are passed click <b>Setup Database</b> otherwise you need to set 755 permissions for folders and 644 for files.
</p>
<p>
<img alt="" src="assets/images/image_2.png">
</p>
<p>
Enter your database credentials you configured in step 1 (configure database) - <span class="note" style="font-size: 14px; line-height: 20px; box-sizing: border-box; margin: 0px 0px 10px; border: 1px solid rgb(251, 167, 102); padding: 1px 10px; border-radius: 4px; background: rgb(255, 248, 242);">
Avoid use of single(‘) and double(“) quotes in your password
</span>
<br />
Click <b>Check Database</b> and if the database connection is successfully you will be passed to the latest step otherwise please re-check your credentials and hostname. (usually hostname is localhost but you should check with your hosting provider or cPanel) </p>
<p>
<strong>Configure admin credentials and options</strong>
</p>
<p>
<img alt="" src="assets/images/image_3.png">
</p>
<ul>
<li>Base URL - <a href="https://help.perfexcrm.com/faq/what-is-base-url/" target="_blank">Read More</a></li>
<li>Email - Admin Login</li>
<li>Password - <span class="note" style="font-size: 14px; line-height: 20px; box-sizing: border-box; margin: 0px 0px 10px; border: 1px solid rgb(251, 167, 102); padding: 1px 10px; border-radius: 4px; background: rgb(255, 248, 242);">
Avoid use of single(‘) and double(“) quotes in your password
</span></li>
<li>Set system timezone - <b>Not recommended changing your timezone after you start using Perfex CRM.</b></li>
<li>Click Install, if the installation is successful you will see the message <b>Installation Successful</b>.</li>
<li>After installation is succesfull, <b>delete the installation folder</b>.</li>
</ul>
<p>
If you need help installing dont hesitate to open <a href="https://support.perfexcrm.com/">support ticket</a>
</p>
<h4><strong>Troubleshooting</strong></h4>
<ul>
<li><a href="https://help.perfexcrm.com/404-not-found-after-installation/">404 Not Found after installation</a></li>
<li><a href="https://help.perfexcrm.com/installing-on-iis-windows-server/">Installing on IIS</a></li>
<li><a href="https://help.perfexcrm.com/nginx-config/">NGINX configuration</a></li>
<li><a href="https://help.perfexcrm.com/aws-email-smtp-setup/">AWS Email SMTP Setup</a></li>
<li><a href="https://help.perfexcrm.com/cant-login-to-admin-area/">Can't login to admin area</a></li>
</ul>
</section>
<section id="setup">
<div class="page-header">
<h3>
<strong>Setup</strong>
</h3>
<hr class="notop">
</div>
<h5>
<strong>Cron Job - Read more how to configure cron job by clicking on the following link: <a href="https://help.perfexcrm.com/setup-cpanel-cron-job/">Setup cPanel CRON</a></strong>
</h5>
<p>
You will need to setup the cron job controller for Perfex
</p>
<p>
Cron job will be used for sending survey emails, auto update invoice statuse eq. if the invoice is overdue etc.
</p>
<p>
<strong>How to setup Cron Job?</strong>
</p>
<p>
Login to your cPanel and navigate to <span>Cron jobs</span>
</p>
<p style="font-size: 14px; line-height: 20px;">
Add the following settings :
</p>
<p style="font-size: 14px; line-height: 20px;">
<img alt="" src="assets/images/image_1.png">
</p>
<p></p>
<pre>wget -q -O- wget -q -O- http://yourdomain.com/crm/cron/index</pre>
<p></p>
<p>
<span>Change the url according to your base url where Perfex CRM is
located. <b>You can check your cron url in Setup->Settings->Cron Job</b></span>
</p>
<p>
Example if its on root domain you need to type only http://yourdomain.com/cron/index
<br style="box-sizing: border-box;"> If its on subfolder /crm you will need to type http://yourdomain.com/crm/cron/index
</p>
<p class="note" style="font-size: 14px; line-height: 20px; box-sizing: border-box; margin: 0px 0px 10px; border: 1px solid rgb(251, 167, 102); padding: 12px; border-radius: 4px; background: rgb(255, 248, 242);">
Cron is required to be setup for Perfex CRM
</p>
<h4><strong>Common CRON Job setup issues</strong></h4>
<p><strong>My server does not support wget command?</strong></p>
<p> If your server does not support wget command you try one of the following commands:</p>
<pre class="lang:php decode:true ">php /home/username/public_html/installation_folder/index.php cron/index >> /dev/null</pre>
<pre class="lang:php decode:true">php /home/username/public_html/installation_folder/index.php cron/index</pre>
<p>
If that doesn’t work, it probably means you don’t have the package php5-cli installed. On debian / ubuntu you can install this package as follows:
</p>
<pre class="lang:sh decode:true ">sudo apt-get install php5-cli</pre>
<p>
If you are not able to install packages, you can specify your path to php try the following command:
</p>
<pre class="lang:php decode:true">/usr/local/bin/php -f /home/username/public_html/installation_folder/index.php cron index</pre>
Replace <strong>username</strong> and <strong>installation_folder</strong> to fit for your path.
If none of commands are not working you can use some free cron job service like https://www.easycron.com. Mostly the free cron job services have limit to execute each 10 minutes but it will work good too with Perfex CRM.
<hr>
<h5>
<strong><a href="https://help.perfexcrm.com/date-format-and-language/">Date Format</a></strong>
</h5>
<p>
Setup your desired date format, will be using all over the application. This option is located in Setup->Settings-> Localization
</p>
<hr>
<h5>
<strong><a href="https://help.perfexcrm.com/smtp-configuration/">General
Email</a></strong>
</h5>
<p>
Navigate to Setup -> Settings -> Email and setup your SMTP email, this will be your base email. You need to <a href="http://support.hostgator.com/articles/specialized-help/email/how-do-i-create-email-accounts-in-cpanel" style="box-sizing: border-box; color: rgb(40, 184, 218); text-decoration: none; background-color: transparent;" target="_blank">setup previously email account from your
cPanel</a> account.
</p>
<hr>
<h5>
<strong><a href="https://help.perfexcrm.com/email-templates/">Email Templates</a></strong>
</h5>
<p>
Check all the email templates, setup signature also in Setup -> Settings -> Email this signature will be using on all email representing your company
</p>
</section>
<section id="faq">
<div class="page-header">
<h3>
<strong>FAQ</strong>
</h3>
<hr class="notop">
</div>
<h5>
<strong>404 Not Found After Installation</strong>
</h5>
<p>
If you are getting 404 not found after you install Perfex CRM this means that you need to adjust the main .htaccess for Perfex CRM.
</p>
<p>
First make sure that the .htaccess file exists in the main folder where you installed Perfex CRM. If you are using any <b>OS</b> make sure you have enabled hidden files on your MAC.
</p>
<p>
Make sure that you have <b>mod_rewrite</b> enabled in your server.
</p>
<p>
<strong>NOTE:</strong> Only apply the following suggestions if you are getting 404 error not found, the default Perfex CRM .htaccess file should work good on most servers.
</p>
<h4><strong>Installation on subfolder.</strong></h4>
<p>This .htaccess may apply if you installed Perfex CRM next to WordPress installation and you are auto redirected to WordPress default 404 Page.</p>
<pre class="lang:php decode:true">RewriteEngine on
RewriteBase /foldername/
RewriteCond $1 !^(index\.php|resources|robots\.txt)
RewriteCond %{REQUEST_FILENAME} !-f
RewriteCond %{REQUEST_FILENAME} !-d
RewriteRule ^(.*)$ index.php?/$1 [L,QSA]
AddDefaultCharset utf-8
</pre>
<h4><strong>Installation on subdomain</strong></h4>
<pre class="lang:php decode:true">RewriteEngine on
RewriteBase /
RewriteCond $1 !^(index\.php|resources|robots\.txt)
RewriteCond %{REQUEST_FILENAME} !-f
RewriteCond %{REQUEST_FILENAME} !-d
RewriteRule ^(.*)$ index.php?/$1 [L,QSA]
AddDefaultCharset utf-8</pre>
<h4><strong>Getting a error 500 and you are using cPanel</strong></h4>
<pre class="lang:php decode:true">RewriteEngine on
RewriteCond $1 !^(index\.php|resources|robots\.txt)
RewriteCond %{REQUEST_FILENAME} !-f
RewriteCond %{REQUEST_FILENAME} !-d
RewriteRule ^(.*)$ subfolder/index.php?/$1 [L,QSA]
AddDefaultCharset utf-8
</pre>
<h4><strong>1&1 Installation</strong></h4>
For 1&1 hosting use the following .htaccess
<pre class="lang:php decode:true">RewriteEngine on
RewriteBase /
RewriteCond $1 !^(index\.php|resources|robots\.txt|static) [NC]
RewriteCond %{REQUEST_FILENAME} !-f
RewriteCond %{REQUEST_FILENAME} !-d
RewriteRule ^(.*)$ index.php/?$1 [L,QSA]
</pre>
<h4><strong>Windows Installation</strong></h4>
Check the following <a href="https://help.perfexcrm.com/installing-on-iis-windows-server/">article</a> for windows web.config file.
<h4><strong>NGINX Installation</strong></h4>
Check the following <a href="https://help.perfexcrm.com/nginx-config/">article </a>for NGINX config.
<p><strong>Other solutions:</strong></p>
<div>Make sure that you have setup <strong>AllowOverride to All</strong> in your config</div>
<div>This can happen if you dont have this option set to All.</div>
<div>You can read more <a href="https://www.digitalocean.com/community/tutorials/how-to-set-up-mod_rewrite-for-apache-on-ubuntu-14-04">here </a>and <a href="http://stackoverflow.com/questions/18740419/how-to-set-allowoverride-all">here</a></div>
<hr />
If you still have problems please open <a href="http://support.perfexcrm.com/">support ticket</a> and we will be glad to assist you as long your server passes the requirements.
<hr />
<h5>
<strong>Cant login to admin area</strong>
</h5>
<p>
Perfex CRM admin area is separated from the customers area. Often happen Perfex CRM buyers to get confused and trying to login as admin in the customers area.
<br />
<br /> Admins needs to login at yourdomain.com/crm/admin
<br /> Customers login at yourdomain.com/crm/clients
<br />
<br /> Hope this will help you.
</p>
</section>
<section id="update">
<div class="page-header">
<h3>
<b>Update</b>
</h3>
<hr class="notop">
</div>
<h4><strong>Steps to perform before upgrading:</strong></h4>
<ol>
<li>Backup files and database (including language files if you are not using <a href="https://help.perfexcrm.com/overwrite-translation-text/">custom_lang.php</a> file to overwrite translation text)</li>
<li>Check the <a href="https://help.perfexcrm.com/category/changelog/">changelog</a> if there are upgrade instructions listed.</li>
</ol>
<hr />
<ol>
<li>Download files from Envato.</li>
<li>Overwrite the following folders (copy folders from new version update files to your current files):
<ol>
<li>application</li>
<li>assets</li>
<li>system</li>
<li>modules</li>
</ol>
</li>
<li>
Overwrite the <strong>pipe.php</strong> file (copy from new version update files to your current files).
</li>
</ol>
<hr />
<h4><strong>Troubleshooting</strong></h4>
<ul style="margin-top: 0px;">
<li>To check what version you are using visit <a href="https://help.perfexcrm.com/faq/how-to-check-what-version-im-using/" target="_blank">click here.</a></li>
<li>If any <strong>css/js errors</strong> outputed on developers console or tables are not loading <strong><span style="color: #ff0000;">make sure you cleared your browser cache</span>.</strong></li>
<li><b>If you are using your own themes/view files</b> eq my_home.php<strong> make sure to re-check them</strong> in case you are getting blank pages bacause may happen some function changes and an error occur in your view file. <strong>Try switching to the original files</strong> to check if everything will work.</li>
<li>Getting 500 error - open <a href="https://support.perfexcrm.com/">support ticket</a> and we will be happy to assist you.</li>
</ul>
</section>
</div>
</body>
</html>