email Feedback About This Page
docs.suitecrm.com: Downloading & Installing (2021-Sep-8)
| SuiteCRM Installation Pre-Requisites Grouped by Category | ||
|---|---|---|
| 🔼 PHP Requirements | ||
| PHP version required |
to determine the php version for your SuiteCRM version use: docs.suitecrm.com: Administrator Guide > Compatibility Matrix |
|
| 🔼 PHP Extensions | log into host's cpanel → go to the Software section → click Select PHP Version → and see PHP Selector and on Extensions tab set/check extension |
|
| curl |
curl is not shown on the Extensions tab. However, when you open phpMyAdmin in your host's cpanel and on the right side under the Web server section you will find the subheading PHP extension with these: curl mbstring mysqli If you see curl there's nothing more for you to do. |
|
| imap | checked | |
| json | checked | |
| mbstring | checked | |
| pcre |
pcre Library - always on php.net: Regular Expressions (Perl-Compatible) The pcre extension is a core PHP extension, so it is always enabled. No need to do anything. | |
| Sprite Support gd |
Sprite support no PHP sprite module module needed for sprite support: gd checked |
|
| XML Parser |
This extension is enabled by default. php.net: XML Parser XML parser extensions available in PHP core: → dom on Extensions tab and checked simplexml xmlparser → xmlreader on Extensions tab and checked xmlrpc → on Extensions tab and checked xmlwriter → on Extensions tab and checked | |
| zip | checked | |
| 🔼 Extensions that can also appear on Extensions tab | ||
| amqp | not checked | |
| apcu | not checked | |
| bcmath | checked | |
| brotli | not checked | |
| dba | not checked | |
| dbase | not checked | |
| dom | checked | |
| eio | checked | |
| enchant | checked | |
| fileinfo | checked | |
| gender | not checked | |
| geoip | not checked | |
| geos | not checked | |
| gmagick | not checked | |
| gnupg | not checked | |
| grpc | not checked | |
| http | not checked | |
| igbinary | not checked | |
| imagick | checked | |
| inotify | not checked | |
| interbase | not checked | |
| intl | checked | |
| ioncube_loader | checked | |
| jsmin | not checked | |
| ldap | not checked | |
| luasandbox | not checked | |
| lzf | not checked | |
| mailparse | not checked | |
| mcrypt | not checked | |
| memcache | not checked | |
| memcached | not checked | |
| mongodb | not checked | |
| mysqli | checked | |
| mysqlnd | checked | |
| nd_mysqli | not checked | |
| nd_pdo_mysql | not checked | |
| newrelic | not checked | |
| oauth | not checked | |
| oci8 | not checked | |
| odbc | not checked | |
| opcache | checked | |
| not checked | ||
| pdo | checked | |
| pdo_dblib | not checked | |
| pdo_firebird | not checked | |
| pdo_mysql | checked | |
| pdo_oci | not checked | |
| pdo_odbc | not checked | |
| pdo_pgsql | not checked | |
| pdo_sqlite | checked | |
| pdo_sqlsrv | not checked | |
| pgsql | not checked | |
| phalcon3 | not checked | |
| phar | checked | |
| posix | not checked | |
| propro | not checked | |
| pspell | checked | |
| psr | not checked | |
| raphf | not checked | |
| redis | not checked | |
| snmp | not checked | |
| soap | checked | |
| sockets | checked | |
| sodium | not checked | |
| sourceguardian | not checked | |
| sqlsrv | not checked | |
| ssh2 | not checked | |
| stats | not checked | |
| swoole | not checked | |
| sysvmsg | checked | |
| sysvsem | checked | |
| sysvshm | checked | |
| tideways | not checked | |
| tidy | not checked | |
| timezonedb | not checked | |
| trader | not checked | |
| uploadprogress | not checked | |
| uuid | not checked | |
| vips | not checked | |
| wddx | checked | |
| xdebug | not checked | |
| xmlreader | checked | |
| xmlrpc | checked | |
| xmlwriter | checked | |
| xsl | checked | |
| yaf | not checked | |
| yaml | checked | |
| zmq | not checked | |
| 🔼 PHP Options |
log into host's cpanel → go to the Software section → click Select PHP Version → and see PHP Selector and on Options tab set/check option |
|
| error_reporting | drop-down box options: ~E_ALL E_ALL & ~E_NOTICE selected E_ALL & ~E_NOTICE & ~E_STRICT E_ALL To fix this error which occurs during install: Notice: Trying to access array offset on value of type null in C:\wamp64\www\uniserve\suitecrmtest\include\utils.php on line 1828 It is necessary to have error_reporting = E_ERROR. It is not possible to use the dropdown box for error_reporting on the Options tab. I have contacted my hosting provider about this problem: 2021-Sep-10 1300. | |
| memory_limit |
drop-down box options: 64M 128M selected 192M 256M 384M 512M 768M 1G |
|
| upload_max_filesize |
drop-down box options: 2M 4M 8M 16M 32M 64M selected 128M 256M 512M 1G 📝 Note: If <6M the install process will flag it as a warning: Warning: Your PHP configuration should be changed to allow files of at least 6MB to be uploaded. | |
| zlib.output_compression |
checkbox default: not checked it needs to be checked |
|
| 🔼 Options that can also appear on Options tab | ||
| allow_url_fopen | checkbox not checked | |
| auto_prepend_file | data-entry area blank | |
| date.timezone "Reset to default" link |
data-entry area often initially set to: UTC php.net: List of Supported Timezones Coordinated Universal Time or UTC is the primary time standard by which the world regulates clocks and time. It is within about 1 second of mean solar time at 0° longitude and is not adjusted for daylight saving time. It is effectively a successor to Greenwich Mean Time (GMT). | |
| disable_functions | data-entry area blank |
|
| display_errors | checkbox not checked | |
| enable_dl | checkbox not checked | |
| error_log | data-entry area set to: error_log | |
| expose_php | checkbox not checked | |
| file_uploads | checkbox checked | |
| include_path | data-entry area set to: .:/opt/alt/php72/usr/share/pear | |
| log_errors | checkbox checked | |
| mail.force_extra_parameters | data-entry area blank drop-down box options: 20 selected 50 | |
| max_execution_time | data-entry area set to: 30 | |
| max_file_uploads | drop-down box options: 20 selected 50 | |
| max_input_time | data-entry area set to: 60 | |
| max_input_vars | data-entry area set to: 1000 | |
| memory_limit | drop-down box options: 64M 128M selected 192M 256M 384M 512M 768M 1G | |
| open_basedir | data-entry area blank | |
| output_buffering | data-entry area set to: false | |
| post_max_size | drop-down box options: 2M 4M 8M 16M 32M 64M selected 128M 256M 512M 1G | |
| register_argc_argv | checkbox not checked | |
| session.save_path | data-entry area set to: /tmp | |
| short_open_tag | checkbox checked | |
| 🔼 Folder and File Permissions | ||
| suitecrm_root and its subfolders |
run: chown -R www-data:www-data. www-data needs to be replaced by the actual system user that your web server runs under. This varies depending on your operating system. Common web server users are as follows:
The commands/steps taken to setting permissions differ depending on your operating system. If you are experiencing issues with setting permissions on your SuiteCRM instance, visit our support forums. | |
| suitecrm_root and its subfolders |
run: chmod -R 755 on it Owner permissions Read, Write, Execute Group permissions Read, No Write, Execute Public permissions Read, No Write, Execute | |
| suitecrm_root/cache and its subfolders |
run: chmod -R 775 on it Owner permissions Read, Write, Execute Group permissions Read, Write, Execute Public permissions Read, No Write, Execute | |
| suitecrm_root/custom and its subfolders |
run: chmod -R 775 on it Owner permissions Read, Write, Execute Group permissions Read, Write, Execute Public permissions Read, No Write, Execute | |
| suitecrm_root/data and its subfolders |
run: chmod -R 775 on it Owner permissions Read, Write, Execute Group permissions Read, Write, Execute Public permissions Read, No Write, Execute | |
| suitecrm_root/modules and its subfolders |
run: chmod -R 775 on it Owner permissions Read, Write, Execute Group permissions Read, Write, Execute Public permissions Read, No Write, Execute | |
| suitecrm_root/themes and its subfolders |
run: chmod -R 775 on it Owner permissions Read, Write, Execute Group permissions Read, Write, Execute Public permissions Read, No Write, Execute | |
| suitecrm_root/upload and its subfolders |
run: chmod -R 775 on it Owner permissions Read, Write, Execute Group permissions Read, Write, Execute Public permissions Read, No Write, Execute | |
|
config.php config_override.php |
these files do not exist before installation takes place nothing to do | |
| 🔼 Optional Directory | ||
| session data directory |
When using SuiteCRM on a shared server, create a new directory outside of public_html and outside of the directory for your SuiteCRM instance.
There isn't a prescribed name for this new session data directory. The mode of this directory is 600 - the owner can read and write to it.Owner permissions Read, Write, No Execute Group permissions No Read, No Write, No Execute Public permissions No Read, No Write, No Execute The full path is needed to this directory - on a Linux system where you are on a shared server starting from your Home Directory: /home/your_account/your_session_dirThis information will be entered on Step 2 of 2 - Configuration of the SuiteCRM installation under the Site Security section for the Security Option: Use a Custom Session Directory for SuiteCRM | |
| 🔼 After Installation is Done | ||
| config_override.php |
run: chmod 775 config_override.php 2>/dev/null Owner permissions Read, Write, Execute Group permissions Read, Write, Execute Public permissions Read, No Write, Execute 📝 Note: /dev/null is a special filesystem object that discards everything written into it |
|