Guia de Instalação

SuiteCRM 7.1 Guia de Instalação

Introdução

SuiteCRM é o SugarCRM turbinado! O SuiteCRM é um fork do popular CRM de código aberto SugarCRM Community Edition (CE). Ele possui diversos módulos adicionais com as características padrão e funcionalidades encontradas no SugarCRM CE.

Notas de lançamento

Confira as notas de lançamento referentes ao SuiteCRM 7.1aqui

Baixando e instalando o SuiteCRM

Se você está instalando o SuiteCRM pela primeira vez, siga as instruções desta seção. Caso já conheça e utilize uma versão anterior do SuiteCRM, confira a seção de atualização para obter detalhes sobre como atualizar sua instância do SuiteCRM. Siga os passos abaixo caso tratar-se de uma primeira instalação:

1. Instale a versão do PHP de acordo com a plataforma existente (Linux ou Windows), servidor web e base de dados.
2. Baixe os arquivos de instalação do SuiteCRM através do site suitecrm.com (confira a seção “Downloading the latest SuiteCRM files”).
3. Copie os arquivos do SuiteCRM para seu servidor web.
4. Instale o SuiteCRM através do assistente de instalação.

Baixando os arquivos mais recentes do SuiteCRM

1. Navegue até seção de downloads do SuiteCRM, existente no site https://suitecrm.com/
2. Autentique-se com suas credenciais (usuário e senha). Caso não tiver uma conta, basta criá-la através do formulário de registro.
3. Baixe o pacote SuiteCRM de sua preferência, de preferência a última versão existente. Esta contém as últimas novidades e correções de bugs.
4. Caso encontrar algum problema durante a criação de sua conta em nosso site ou durante o download, por favor reporte-nos através do nosso fórum de suporte.

Copiando os arquivos do SuiteCRM para o servidor web

Após baixar o pacote SuiteCRM, será necessário descompactá-lo e também configurar as devidas permissões para início do processo de instalação. Os passos a seguir detalham os pré-requisitos necessários para os arquivos de instalação do SuiteCRM:

1. Localize o diretório no servidor web onde o SuiteCRM será instalado (o mais comum é o diretório raiz, ou algum subdiretório existente nele).
2. Descompacte o pacote SuiteCRM dentro do diretório selecionado durante o passo 1. Será criado o diretório “SuiteCRM” abaixo da pasta escolhida anteriormente.
3. Durante este passo, talvez você deseje renomear o diretório “SuiteCRM”. Se for o caso, realize esta alteração agora.
4. Defina o proprietário do diretório SuiteCRM:
   1. chgrp ApacheUser.ApacheGroup <suitecrmroot> -R Define o proprietário da pasta raíz recursivamente para o usuário Apache e seu grupo.
5. O usuário do sistema que seu servidor web utiliza varia de acordo com o sistema operacional utilizado. Os mais comuns são:
   1. apache (Linux/Apache)
   2. nobody (Linux/Apache)
   3. IUSR_computerName (Windows/IIS)

Caso estiver na dúvida sobre qual usuário escolher para seu servidor web, contate seu provedor de hospedagem. Se estiver instalando o SuiteCRM localmente e precisar de suporte, visite nossos fóruns.

1. Defina as seguintes permissões para o diretório SuiteCRM (Linux):
   1. sudo chown -R www-data:www-data .
   2. sudo chmod -R 755 .
   3. sudo chmod -R 775 cache custom modules themes data upload config_override.php

Os commandos mencionados acima podem variar dependendo do sistema operacional. Caso obter problemas durante estas definições em sua instância do SuiteCRM, visite nossos fóruns de suporte.

Pré-requisitos de instalação recomendados

• PHP
• JSON
• XML Parsing
• MB Strings Module
• Permissão de escrita para o arquivo de configuração do SugarCRM (config.php)
• Permissão de escrita para o diretório Custom
• Permissão de escrita para os subdiretórios dos Módulos e seus Arquivos
• Permissão de escrita para o diretório de Upload
• Permissão de escrita para o diretório Data e seus subdiretórios
• Permissão de escrita para o diretório Cache e seus subdiretórios
• Limite de Memória do PHP (no mínimo 128M)
• Módulo de Compressão ZLIB
• Módulo ZIP Handling
• Biblioteca PCRE
• Módulo IMAP
• Módulo cURL
• Tamanho de Arquivo para Upload
• Suporte a Sprite

Instalando o SuiteCRM

Uma vez copiado os arquivos do SuiteCRM para seu servidor web, será necessário instalá-lo seguindo os passos do assistente de instalação. Para abrir o assistente, acesse o endereço de sua instância SuiteCRM pelo navegador: http://<yourServer>/<yourSuiteCRMDirectory>/install.php. Basta prosseguir com a instalação típica ou personalizada. Recomendamos a instalação típica, mas você pode preferir a personalizada devido a razões como, por exemplo: O usuário administrador do banco de dados não pode ser o mesmo para a base de dados do SuiteCRM, preferência em configurar a localidade durante a instalação do SuiteCRM (ao invés de fazê-lo depois de instalado), etc.

Realizando uma instalação típica do SuiteCRM

1. Abra seu navegador e informe o endereço: http://<yourServer>/<yourSuiteCRMDirectory>/install.php
   • Será visualizado a página de boas vindas.
2. Clique em “Next”.
   • O instalador mostrará instruções de instalação e alguns requisitos que o ajudarão durante o processo.
3. Revise as informações e clique em “Next”.
   • Será visualizado o Acordo de Licença do SuiteCRM.
4. Revise a licença, marque a caixa “I Accept”, e clique em “Next”. O instalador irá conferir a compatibilidade do sistema e mostrará em seguida uma página com opções de instalação.
   • Nota: Você pode modificar as configurações a qualquer momento antes de clicar em “Install”. Para isso, clique no botão “Voltar” de seu navegador para retornar à página desejada.
5. Selecione “Instalação Típica”.
6. Clique em “Next”. Será visualizado a página “Database Type”.
7. Selecione o tipo de banco de dados que está instalado em seu sistema e clique em “Next”. Será visualizado a página “Database Configuration”.

   a. Informe o nome da base de dados. O instalador usa por padrão “suitecrm” como nome. Você pode especificar outro nome, caso desejar.

   b. Informe o nome do Host ou instância do MySQL, MariaDB ou SQL Server. O nome do host por padrão é “localhost”, caso seu servidor de banco de dados estiver hospedado na mesma máquina que seu servidor web.

   c. Informe o nome de usuário e senha do administrador do banco de dados.

   d. Certifique-se de que o administrador da base de dados tenha permissões de criação e escrita na base de dados.

   Para o My SQL, MariaDB e SQL Server, por padrão, o instalador seleciona como usuário administrador o mesmo informado para a base de dados do SuiteCRM. A aplicação SuiteCRM utiliza o usuário da base de dados para se comunicar com a mesma. Você pode especificar um usuário de base de dados diferente neste passo, caso desejar.

   1. 1. Para selecionar um usuário existente, escolha “Provide existing user” na lista drop-down. Para criar um novo usuário de base de dados, escolha “Define user”. Informe o nome do usuário da base de dados e a senha nos campos correspondentes. Informe novamente a senha para confirmá-la. As informações do novo usuário aparecerão no bloco Credenciais do Sistema existente na página de confirmação das configurações ao final do processo de instalação.
   • e.Deixe a opção padrão “No” caso não desejar que os dados de demonstração do SuiteCRM sejam inseridos. Selecione “Yes” para popular a base de dados com os dados de demonstração.
8. Clique em “Next”. O instalador validará as credenciais do administrador informado. Se uma base de dados com este nome já existir, sera visualizado uma caixa de diálogo questionando se deseja manter o nome ou escolher outro para a nova base de dados. Se você selecionar uma base de dados existente, as tabelas desta base serão descartadas.
9. Clique em “Accept” para aceitar o nome da base de dados ou “Cancel” para informar outro nome.
   • Visualizará em seguida a página de configuração do site.
10. Informe um nome para o administrador da aplicação SuiteCRM.
    • O administrador do SuiteCRM (o nome padrão é “admin”) possui privilégios administrativos na aplicação. Você pode alterar o nome padrão deste usuário.
11. Informe uma senha para o usuário administrador, confirme a mesma novamente, e clique em “Next”.
    • Isso mostrará a tela de confirmação das configurações. Trata-se de um sumário das configurações que foram selecionadas ou inseridas até então. Clique em “Voltar” no seu navegador para retornar à página anterior caso deseje alterar algo.
12. Clique em “Print Summary” caso deseje imprimir estas configurações.
    • Clique em “Show Passwords” e logo após em “Print Summary” para incluir as informações relacionadas a base de dados, como usuário, senha e as credenciais administrativas do SuiteCRM. Quando você clicar em “Show Passwords”, o sistema mostrará as senhas e o botão mudará para “Hide Passwords”. Para ocultar estas informações, basta clicar neste.
13. Clique em “Install”.
    • Será visualizado a tela de Setup com o progresso da instalação.
14. Click Next when the setup is complete.
    • This displays the Registration page(registration is optional).
15. Enter the necessary information and click Send Registration to register your SuiteCRM instance with SuiteCRM; or click No Thanks to skip registration.
    • This displays the SuiteCRM login page. You can now log into SuiteCRM with the SuiteCRM admin name and password that you specified during installation.

Performing a custom installation of SuiteCRM

1. Launch your browser and go to your new SuiteCRM installation. The URL should be similar to the following:

   http://crm.yourserver.com/Suite-CRM-Directory/install.php

2. The Welcome to the SuiteCRM Setup Wizard screen

   You need to accept the licence agreement first. To do so:

   1. Click the I Accept checkbox.
   2. Click Next to continue.

3. The Pre-Installation requirements screen

   The installer will display installation instructions and requirements.

   1. Please review the information and resolve any issues.
   2. Click Next to continue.

4. The Configuration screen

   This is where you will configure SuiteCRM to work with your customized environment.

   1. Database Configuration
      1. Specify Database Type

         Select the type of database you will be using. If you do not see your database here, please make sure you have installed the correct php modules.

      2. Provide Database Name
         1. Database Name

            suitecrm is default name for the database. You can specify a custom name as well.

         2. Host Name

            It is set to localhost by default. If your database server is running on a different machine as your web server, you can specify a custom location.

         3. User & Password

            Enter the username and password for the Database Administrator and specify the SuiteCRM Database Username. Note: You must ensure that the Database Administrator you specify has the permissions to create and write to the SuiteCRM database.

         4. SuiteCRM Database User

            The SuiteCRM application uses the SuiteCRM Database user to communicate with the SuiteCRM database. For MySQL, MariaDB and SQL Server, the Installer selects the Admin user by default. You can also select an existing database user or create a new one. To do so Enter the database username and password in the relevant fields and re-enter the password to confirm it. This new user information displays in System Credentials on the Confirm Settings page at the end of the installation process.

   2. Site Configuration
      1. Identify Administration User
         1. SuiteCRM Application Admin Name

            This is the username of the administrator account. Ex: johnsmith

         2. SuiteCRM Admin User Password

            This is the password of the administrator account. Please re-enter it in the Re-enter SuiteCRM Admin User Password section for validation.

         3. URL of SuiteCRM Instance

            The URL to the CRM. Ex: http://crm.yourserver.com/Suite-CRM-Directory

         4. Email Address

            This is the administrator's email address. Ex: john.smith@yourserver.com

   3. More Options

      In this section you can opt to:

      • Populate SuiteCRM with semo data
      • Add SMTP server specifications
      • Add branding (Name and logo)
      • Set the system locale
      • Set security options

   Once you are happy with all the settings on the page click Next to begin installation.

5. The Installation screen

   The Installer validates the credentials of the specified administrator. If a database with the specified name already exists, it displays a dialog box prompting you to either accept the database name or choose a new database. If you use an existing database name, the database tables will be dropped. Click Accept to drop current tables or click Cancel and specify a new database name.

6. Login to your new SuiteCRM instance!

Upgrading SuiteCRM

Log into your SuiteCRM instance to use the Upgrade Wizard. There is currently no silent upgrade path available for SuiteCRM. CAUTION: It is strongly recommended that you run the upgrade process on a copy of your production system.

Compatibility matrix for upgrade

Note: SuiteCRM 7.2.x requires PHP 5.3+(5.3 or newer).

Note: SuiteCRM 7.5 requires PHP 5.4+ (5.4 or newer) because PHP new short array syntax is being used at least once in Reports module.

Click here for the full compatibility matrix.

PHP version

• 5.2.1-5.2.6
• 5.2.8-5.2.15
• 5.2.17
• 5.3.0 - 5.3.6

Databases

• MySQL - 5.0x, 5.1
• MSSQL - 2005, 2008

Operating systems

• Windows: Sugar runs on any OS that runs PHP
• Linux: Sugar runs on any OS that runs PHP
• Mac: Sugar runs on any OS that runs PHP

Upgrading to SuiteCRM from SugarCRM Community Edition

Upgrade paths are available for SugarCRM to SuiteCRM from the SuiteCRM downloads section of the SuiteCRM website. To validate what versions of SugarCRM are compatible with the respective SuiteCRM versions, please check the table below:

SuiteCRM Version	SugarCRM Version
SuiteCRM 7.0.1	SugarCRM 6.5.x
SuiteCRM 7.0.0	SugarCRM 6.5.x

Upgrade prerequisites

• Backup your current SuiteCRM directory and database before beginning the upgrade process.
• Disable op-code caching before upgrading your SuiteCRM installation if op-code caching is enabled in the PHP configuration file. You can enable it after the upgrade process is complete.
• Increase the default value of the parameters listed below before you begin the upgrade process if you are using Zend Core 2.0:
  • Navigate to C:\Program Files\Zend\Core\etc\fastcgi.conf and increase the default value for ConnectionTimeout to 3000 seconds and RequestTimeout to 6000 seconds.
  • Navigate to the php.ini file and increase the default value of max_execution_time to 6000 seconds.
• Perform the following for the large size of the upgrade files:
  • Modify and save the value of Maximum upload size to 21000000 (20MB) in the Advanced section of the System Settings page of your current SuiteCRM installation.
  • Navigate to the php.ini file on your web server and configure the parameters listed below in the Advanced section of the System Settings page of your current SuiteCRM installation:
    • Set post_max_size to at least 60MB
    • Set upload_max_filesize settings to at least 60MB
    • Set max_input_time to a large number
    • Set memory_limit to 256MB

Restart the web server and begin the upgrade process.

• Ensure that LimitRequestBody is set to a large number or use the default value of 2GB if you are using an Apache web server and LimitRequestBody is set in the httpd.conffile. Restart Apache and begin the upgrade process.
• Ensure that the webserver user has write permissions to the SuiteCRM database. The upgrade to SuiteCRM 7.0.x will add and replace files in several locations including the SuiteCRM root directory. The webserver user must have write permissions for the root folder and all sub-directories during the upgrade process.
• The process of upgrading can take up to 30 minutes. Set the CGI script timeout to more than the default 300 seconds to ensure that the CGI application does not time out if you are using the IIS web server.
• Save PHP files for customized modules (for example, accounts.php) in the Customs directory and not within the main module. Existing customizations may be overridden by changes in SuiteCRM 7.0.x during upgrade.

Upgrade considerations

The Dynamic Teams feature requires some database schema changes across all modules as part of the upgrade process. For larger databases, this operation can take some time to complete. Follow the steps listed below to ensure a smooth upgrade process:

1. Test your upgrade on a development instance instead of the production instance.
2. Use the Silent Upgrade method through the command line interface to conduct the upgrade instead of the Upgrade Wizard inside the application if your database contains more than 10000 records per table.
3. Log into the application as an Administrator and use the Repair option to repair and rebuild the database after the upgrade is complete.

Using the Upgrade Wizard

The Upgrade Wizard provides a quick way to upgrade to the latest version of the SuiteCRM application. It includes critical upgrade logic as well as the SQL commands needed to upgrade the application. Ensure that the config.php file for your installation, located in the SuiteCRM root directory, is writable, before using the Upgrade Wizard. Note: Manual upgrades by file replacements and running the upgrade SQL are not supported.

Upgrading SuiteCRM using the Upgrade Wizard

1. Download the appropriate SuiteCRM Upgrade zip file from the SuiteCRM website to your local machine. For example, download the SuiteCRMPro-Upgrade-6.4.x-to-6.5.0.zipfile to upgrade SuiteCRM Professional from version 6.4.x to 6.5.0. Download the appropriate conversion file to convert to SuiteCRM Professional or SuiteCRM Enterprise.
2. Log into your existing SuiteCRM application as the administrator and click admin on the right-hand corner of the page.
3. Click Upgrade Wizard in the Systems panel of the Administration Home page.
   • This displays the Upgrade Wizard page.
4. Click Next.
   • This displays the System Checks page. and SuiteCRM begins the system check process. The Systems Check page indicates that there were no issues if the system check process completes successfully. Issues with file permissions, database, and server settings are listed on the page if the system check process encountered any problems.
5. Click Next if the system check is successful.
   • This displays the Upload an Upgrade page.
6. Click Browse, and navigate to the location of the upgrade zip file and select it.
   • The path to the file displays in the Upload an upgrade field.
7. Click Upload Upgrade to upload the package to the SuiteCRM application.
   • The system uploads the package and displays it on the page. Use the Delete Package button to remove the package if necessary.
8. Click Next.
   • This displays the Preflight Check page.
   • Click Show Schema Change Script toview differences in the SuiteCRM databases schema between your current and new SuiteCRM versions.
   • By default, the Upgrade Wizard Runs SQL option is selected as the database update method. Select Manual SQL Queries from the Database Update Method drop-down list and select the Check when SQL has been manually run box, if you ran the SQL queries manually.
9. Click Recheck to rerun Preflight Check. Click Next to skip this step.
   • This displays the Commit Upgrade page.
   • You can also click Show to see a list of files that were copied and the rebuilt results. You can also view skipped queries.
10. Click Next.
    • During the upgrade process, SuiteCRM performs a three-way merge between the customized instance on old version, default instance on old version, and default instance on new version. This three-way merge adds any fields that have been added to the default module layouts in the new version to the corresponding module layouts in the existing version, if the module layouts in the old version were not customized through Studio (or in the appropriate upgrade-safe way) prior to the upgrade. The three-way merge also changes the placement of fields in non-Studio-customized module layouts to match the placement in the default module layouts.
    • SuiteCRM displays the Confirm Layouts page as Step 5 of the upgrade process if the existing module layouts have been customized, and there are changes to the default fields and field placement in the new module layouts.
    • The Confirm Layouts page lists the module layouts that have changed in the new version. The administrator has the option of applying the changes to the existing module layouts. By default, all of the listed module layouts are selected to be merged during the upgrade.
    • For example, in 6.1.0, SuiteCRM added the Assigned To fields to the default Detail View and Edit View layouts for Notes and for Email Templates. If the instance being upgraded has a customized EditView layout for Notes, but no customized layouts for Email Templates, the following will occur during the upgrade:

    a. The Confirm Layouts page appears as Step 5 in the Upgrade Wizard

    b. The Confirm Layouts page displays the Notes module with the EditView and DetailView layouts. The Email Templates layouts do not display on the Confirm Layouts page because the existing layouts were not customized.

    c. The Administrator has the option of choosing to merge the changes in the Notes module with the existing customized EditView layout.

11. Uncheck the module if you do not want to add the new fields to a module.
12. Click Next.
    • This displays a message confirming that the layouts were successfully merged (if you chose to update your modules).
13. Click Next.
14. The Debrief page confirms the upgrade installation. Complete the steps for manual merging of files or running SQL queries now.
15. Click Done.
    • This displays the Home page indicating that the upgrade is complete.
16. Click Repair and select the Rebuild Relationships andRebuild Extensions options in the Systems panel of the Administration Home page.
    • For more information, see Repair.
17. Manually merge the files by extracting the skipped file from the patch zip file if you unchecked any files to prevent the Upgrade Wizard from overwriting them. Merge the file installed in the SuiteCRM application directory.
    • Note:Check the upgradeWizard.log file in the SuiteCRM folder for information on unsuccessful SuiteCRM upgrades.

Uninstalling a SuiteCRM instance

Follow these steps to uninstall your SuiteCRM instance:

1. Navigate to the directory within your web server where SuiteCRM is located.
2. Remove the SuiteCRM directory(Linux: rm -r <suitedirectory> if you wish to be prompted, rm -rf <suitedirectory> if you wish to delete the directory without being prompted).
3. Delete the SuiteCRM database schema from your server database(default is “suitecrm”, this will differ if this has been renamed during the installation process)..

Troubleshooting and Support

SuiteCRM is an open source project. As such please do not contact us directly via email or phone for SuiteCRM support. Instead please use our support forum. By using the forum the knowledge is shared with everyone in the community. Our developers answer questions on the forum daily but it also gives the other members of the community the opportunity to contribute. If you would like customisations to specifically fit your SuiteCRM needs then please use our contact form.