Please read the following important information before proceeding with the installation. The information will help you determine whether or not you are ready to install the application at this time.
| Required System Components
Before you begin, please be sure that you have the supported versions of the following system
- Database/Database Management System (Examples: MySQL, SQL Server, Oracle)
- Web Server (Apache, IIS)
Consult the Compatibility Matrix in the Release Notes for
compatible system components for the Sugar version that you are installing.
| Initial System Check
When you begin the installation process, a system check will be performed on the web server on which the Sugar files are located in order to
make sure the system is configured properly and has all of the necessary components
to successfully complete the installation.
The system checks all of the following:
- PHP version – must be compatible
with the application
- Session Variables – must be working properly
- MB Strings – must be installed and enabled in php.ini
- Database Support – must exist for MySQL, SQL
Server or Oracle
- Config.php – must exist and must have the appropriate
permissions to make it writeable
- The following Sugar files must be writeable:
If the check fails, you will not be able to proceed with the installation. An error message will be displayed, explaining why your system
did not pass the check.
After making any necessary changes, you can undergo the system
check again to continue the installation.
| Typical or Custom install
After the system check is performed, you can choose either
the Typical or the Custom installation.
For both Typical
installations, you will need to know the following:
- Type of database that will house the Sugar data
- Compatible database
types: MySQL, MS SQL Server, Oracle.
- Name of the web server or machine (host) on which the database is located
- This may be localhost if the database is on your local computer or is on the same web server or machine as your Sugar files.
- Name of the database that you would like to use to house the Sugar data
- You might already have an existing database that you would like to use. If
you provide the name of an existing database, the tables in the database will
be dropped during installation when the schema for the Sugar database is defined.
- If you do not already have a database, the name you provide will be used for
the new database that is created for the instance during installation.
- Database administrator user name and password
- The database administrator should be able to create tables and users and write to the database.
- You might need to
contact your database administrator for this information if the database is
not located on your local computer and/or if you are not the database administrator.
- Sugar database user name and password
- The user may be the database administrator, or you may provide the name of
another existing database user.
- If you would like to create a new database user for this purpose, you will
be able to provide a new username and password during the installation process,
and the user will be created during installation.
For the Custom setup, you might also need to know the following:
- URL that will be used to access the Sugar instance after it is installed.
This URL should include the web server or machine name or IP address.
- [Optional] Path to the session directory if you wish to use a custom
session directory for Sugar information in order to prevent session data from
being vulnerable on shared servers.
- [Optional] Path to a custom log directory if you wish to override the default directory for the Sugar log.
- [Optional] Application ID if you wish to override the auto-generated
ID that ensures that sessions of one Sugar instance are not used by other instances.
- Character Set most commonly used in your locale.
For more detailed information, please consult the Installation Guide.