Mudanças entre as edições de "Guia de Instalação"

Edição atual tal como às 10h40min de 5 de julho de 2017

SuiteCRM 7.9 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 versão

Confira as notas de versão referentes ao SuiteCRM 7.9 aqui

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. Clique em “Next” quando o setup for concluído.
    • Em seguida será visualizado a página de registro do produto (preenchimento opcional).
15. Insira os dados necessário e clique em “Send Registration” para registrar sua instância do SuiteCRM junto ao site SuiteCRM; ou em “No Thanks” para pular esta etapa.
    • Finalmente, visualizaremos a página de autenticação do SuiteCRM. Agora você poderá autenticar-se no sistema com as credenciais administrativas que foram criadas durante as etapas anteriores.

Realizando uma instalação personalizada do SuiteCRM

1. Abra seu navegador e inicie sua nova instalação do SuiteCRM. O endereço deve ser algo semelhante ao mostrado abaixo:

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

2. Será visualizado a tela de “bem-vindo” (Welcome to the SuiteCRM Setup Wizard).

   Você precisa aceitar os termos de licença primeiro. Para isso:

   1. Marque a caixa “I Accept”.
   2. Clique em “Next” para continuar.

3. Será visualizado a tela de requisitos pré-instalação (Pre-Installation requirements)

   O instalador mostrará instruções e requisitos de instalação.

   1. Por favor, revise estas informações e corrija o que desejar.
   2. Clique em “Next” para continuar.

4. A tela de Configuração

   Aqui é onde você irá configurar o SuiteCRM conforme o ambiente que o hospedará.

   1. Configuração da base de dados
      1. Especifique o tipo de base de dados.

         Selecione o tipo de base de dados que estás utilizando. Caso não visualizar sua base de dados nesta tela, por favor confira a instalação dos módulos PHP em seu ambiente.

      2. Informe o nome da base de dados
         1. Nome da base de dados

            suitecrm é o nome padrão da base de dados. Você pode especificar outro nome, se assim desejar.

         2. Nome do Host

            por padrão é localhost Se o servidor de banco de dados estiver hospedado em outra máquina diferente da que hospeda o servidor web, é possível corrigir esta informação neste momento.

         3. usuário & Senha

            Informe o nome da base, o nome do usuário e a senha da base de dados do SuiteCRM. Nota: Certifique-se que o usuário da base de dados possua as devidas permissões para criar e gravar nela.

         4. Usuário da base de dados do SuiteCRM

            A aplicação SuiteCRM utiliza o usuário da base de dados para se comunicar com a respectiva base. Para servidores MySQL, MariaDB e SQL Server, o instalador seleciona o usuário “Admin” por padrão. Você pode selecionar um usuário existente ou criar um novo. Para isso, informe um nome de usuário e senha nos campos correspondentes e confirme novamente a senha. Estas novas informações de usuário aparecerão no bloco“System Credentials” existente na página “Confirm Settings” ao final do processo de instalação.

   2. Configuração do Site
      1. Identifique o Usuário Administrador
         1. Nome do Administrador da aplicação SuiteCRM

            Este é o nome do usuário da conta de administrador do SuiteCRM. Exemplo: joaoferreira

         2. Senha do Administrador da aplicação SuiteCRM

            Esta é a senha da conta do administrador. Por favor, confirme esta senha novamente, para validação.

         3. URL da instância SuiteCRM

            O endereço do site do CRM. Ex: http://crm.yourserver.com/Suite-CRM-Directory

         4. Endereço de Email

            Este é o endereço de e-mail do administrador do sistema. Exemplo: joao.ferreira@yourserver.com

   3. Mais Opções

      Nesta seção você pode optar por:

      • Popular o SuiteCRM com dados de demonstração
      • Configurar o servidor SMTP (saída de emails)
      • Adicionar sua marca (nome e logomarca de sua empresa)
      • Configurar a localidade do sistema (região, fuso-horário, etc)
      • Configurar opções de segurança

   Caso estiver satisfeito com todas as configurações informadas nesta página, clique em “Next” para iniciar a instalação.

5. A tela de Instalação

   O instalador validará as credenciais do administrador informado. Se uma base de dados existir com o mesmo nome, visualizará uma caixa de diálogo questionando se deseja prosseguir mesmo assim ou escolher uma nova base de dados. Se você usar uma base de dados existente, as tabelas desta base de dados serão descartadas. Clique em “Accept” para descartar as tabelas atuais ou “Cancel” para especificar um nome para a nova base de dados.

6. Autentique-se em sua nova instância do SuiteCRM!

Atualizando o SuiteCRM

Autentique-se em sua instância do SuiteCRM para utilizar o assistente de atualização. Atualmente não há pacote para atualização silenciosa disponível para o SuiteCRM (há apenas para o Sugar). ATENÇÃO: Recomendamos que você atualize o SuiteCRM em um ambiente de homologação. Não atualize seu ambiente de produção diretamente!

Matriz de compatibilidade para atualização

O SuiteCRM é executado em uma variedade de sistemas operacionais, servidores Web, bancos de dados e versões PHP. Ele suporta muitos navegadores.

Clique aqui para visualizar a matriz completa de compatibilidade.

Nota: SuiteCRM 7.2.x requer PHP 5.3+(5.3 ou superior).

Nota: SuiteCRM 7.5 requer PHP 5.4+ (5.4 ou superior) pois o recurso PHP new short array syntax é utilizado a partir desta versão no módulo de Relatórios.

Versões do PHP

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

Banco de dados

• MySQL - 5.0x, 5.1
• MSSQL - 2005, 2008
• MariaDB - 5.5, 10, 10.1

Sistemas Operacionais

• Windows: Sugar funciona em qualquer SO que suporte PHP
• Linux: Sugar funciona em qualquer SO que suporte PHP
• Mac: Sugar funciona em qualquer SO que suporte PHP

Atualizando para o SuiteCRM a partir do SugarCRM Community Edition

Pacotes de atualização estão disponíveis para atualizar o SugarCRM para o SuiteCRM. Confira a seção de downloads no site do SuiteCRM. Para verificar quais versões do SugarCRM são compatíveis com as respectivas versões do SuiteCRM, por favor confira abaixo:

Pré-requisitos para atualização

• Faça backup do seu diretório SuiteCRM e também da base de dados antes de prosseguir com o processo de atualização.
• Desabilite o “caching op-code” antes de atualizar sua instalação do SuiteCRM, no arquivo de configuração PHP. Você pode reabilitá-lo após a conclusão do processo de atualização.
• Aumente o valor padrão dos parâmetros listados abaixo antes de iniciar o processo de atualização, caso estiver usando “Zend Core 2.0”:
  • Localize o arquivo C:\Program Files\Zend\Core\etc\fastcgi.conf e aumente o valor padrão dos parâmetros “ConnectionTimeout” para 3000 segundos e o “RequestTimeout” para 6000 segundos.
  • Localize o arquivo php.ini e aumente o valor padrão do parâmetro “max_execution_time” para 6000 segundos.
• Realize as alterações a seguir para que o processo suporte o grande tamanho dos arquivos de atualização:
  • Altere para 21000000 (20MB) o parâmetro “Tamanho máximo de Arquivos para carregar” na seção “Avançado” da página de “Definições de Sistema”. Para isso, deverá autenticar-se como administrador em sua instância atual do SuiteCRM.
  • Localize o arquivo php.ini em seu servidor web e configure os parâmetros listados abaixo:
    • Defina post_max_size para no mínimo 60MB
    • Defina upload_max_filesize para no mínimo 60MB
    • Defina max_input_time para um número bem maior
    • Defina memory_limit para 256MB

Reinicie o servidor web e comece o proceso de atualização.

• Certifique-se de que o parâmetro “LimitRequestBody” esteja definido com um número maior ou use o valor padrão de 2GB, caso estiver usando um servidor web Apache e o parâmetro “LimitRequestBody” exista no arquivo httpd.conf. Reinicie o Apache e comece o processo de atualização.
• Certifique-se de que o usuário do servidor web tenha permissão de escrita na base de dados do SuiteCRM. O processo de atualização para o SuiteCRM 7.0.x irá adicionar e remover arquivos de diversas pastas incluindo o diretório raíz do SuiteCRM. O usuário do servidor web deve ter permissões de escrita para a pasta raíz de todos seus subdiretórios durante o processo de atualização.
• O processo de atualização dura cerca de 30 minutos. Defina o parâmetro “timeout” no script CGI para mais de 300 segundos para garantir que a aplicação CGI não gere timeout, caso estiver usando o IIS como servidor web (Windows).
• Faça backup dos arquivos PHP que contenham algum tipo de customização para seus módulos (por exemplo, o “accounts.php”) no diretório “Customs” (e não somente no módulo principal). Caso existirem customizações, estas serão perdidas no SuiteCRM 7.0.x durante a atualização.

Considerações sobre o processo de atualização

O recurso “Dynamic Teams” requer algumas alterações no schema de banco de dados em todos os módulos, como parte do processo de atualização. Para bases de dados maiores, esta operação pode durar muito tempo para que seja concluída. Siga os passos abaixo para amenizar o tempo de atualização:

1. Teste a atualização em um ambiente a parte, de desenvolvimento (ou homologação) ao invés de atualizar diretamente em produção.
2. Use o método de atualização silenciosa através da interface de linha de comando para conduzir todo processo, ao invés do assistente de atualização, dentro da aplicação (caso sua base de dados possuir mais que 10000 registros por tabela).
3. Autentique-se na aplicação como administrador e use a opção “Reparar Estruturas” para reparar e reconstruir a base de dados após o término da atualização.

Usando o Assistente de Atualização

O assistente de atualização lhe proporciona um curto caminho para atualizar sua aplicação para a última versão existente do SuiteCRM. Isso inclui atualizações críticas de código como também alguns comandos SQL necessários para a atualização. Certifique-se de que o arquivo config.php (localizado no diretório raíz do SuiteCRM) possua permissão de escrita, antes de usar o assistente de atualização. Nota: Atualizações manuais através de substituição de arquivos fonte e execução de scripts SQL não são suportados pelo assistente de atualização.

Atualizando o SuiteCRM através do Assitente

1. Baixe o pacote de atualização apropriado do site do SuiteCRM.
2. Autentique-se na instância do SuiteCRM existente como administrador e clique em “admin” no lado superior direito da tela.
3. Clique em “Assistente de Atualização” no painel administrativo do sistema.
   • Será visualizado a página do assistente de atualização.
4. Clique em “Next”.
   • Você visualizará a página de checagem do sistema e o SuiteCRM iniciará este processo. O processo de checagem irá conferir se há algum problema que o impeça de prosseguir com a atualização. Problemas como permissão de arquivos, base de dados e configurações do servidor serão listadas nesta página caso seja encontrado alguma falha.
5. Clique em “Next” se a checagem do sistema for concluída com êxito.
   • Será visualizado a página de Upload e Atualização.
6. Clique em Procurar e localize o pacote de atualização baixado anteriormente. Selecione-o.
   • O caminho do arquivo será visualizado nos campos de Upload e Atualização.
7. Clique em “Upload Upgrade” para enviar o pacote para a aplicação SuiteCRM.
   • O sistema enviará o pacote e irá mostrá-lo na página. Use o botão “Delete Package” para removê-lo, se necessário.
8. Clique em “Next”.
   • Será visualizado a página de checagem.
   • Clique em “Show Schema Change Script” para visualizar as diferenças entre o schema atual da base de dados do SuiteCRM e a nova versão.
   • Por padrão, o assitente de atualização marca a opção “Runs SQL”, como método de atualização da base de dados. Selecione “Manual SQL Queries” na lista drop-down e também a opção “Check when SQL has been manually run”, caso deseja executar as queries manualmente na sua base de dados.
9. Clique em “Recheck” para executar novamente a checagem. Clique em “Next” caso deseja pular esta etapa.
   • Será visualizado a página “Commit Upgrade”.
   • Você também pode clicar em “Show” para visualizar a lista de arquivos que foram copiados e os resultados da reestruturação. É possível também visualizar as queries que foram ignoradas.
10. Clique em "Next".
    • Durante o processo de atualização, o SuiteCRM realiza uma mesclagem de três vias entre a instância personalizada em versão antiga, a instância padrão em versão antiga, e a instância padrão da nova versão. Esta mesclagem de três vias adiciona todos os campos existentes nos layouts de módulos padrão da nova versão aos layouts dos módulos correspondentes da versão existente, se os layouts dos módulos na versão anterior do sistema não sofreram personalizações através do Studio (antes da atualização). A mesclagem das três vias também muda o posicionamento dos campos em layouts de módulos cujo não sofreram customizações através do Studio para que coincidam com o posicionamento dos campos nos layouts de módulos padrão.
    • O SuiteCRM exibe a página de confirmação de layouts como “Passo 5” do processo de atualização se os layouts de módulos existentes foram personalizados, e há mudanças para os campos padrão e adiciona os campos nos novos layouts dos módulos.
    • A tela de confirmação do layout lista os layouts dos módulos que sofreram alterações na nova versão. Por padrão, todos os layouts dos módulos listados são selecionados para mesclagem durante a atualização.
    • Por exemplo, na versão 6.1.0, o SuiteCRM possui o campo “Atribuído a” na tela de detalhes, na tela de edição e também nos templates de Email. Se a instância foi atualizada e tinha campos personalizados na tela de edição mas não tinha o mesmo em nenhum layout de Email, ocorrerá o seguinte durante a atualização:

    a. A tela de confirmação de layout aparecerá como passo 5 no assistente de atualização.

    b. A tela de confirmação mostrará o módulo com os layouts da tela de edição e detalhes. Os templates de Email não mostrarão os campos alterados, pois não foram customizados.

    c. O administrador terá a opção de mesclar as alterações nos módulos com as alterações existentes na tela de detalhes e edição.

11. Desmarque o módulo caso não queira adicionar os campos personalizados nele.
12. Clique em "Next".
    • Será visualizado uma mensagem informando que a mesclagem dos layouts ocorreu com êxito (caso optou por atualizar seus módulos).
13. Clique em "Next".
14. A página confirmará a atualização. Prossiga com os passospara mesclagem manual dos arquivos ou execução das queries do SQL agora.
15. Clique em “Done”.
    • Você visualizará a página inicial indicando que a atualização foi concluída.
16. Clique em “Reparar Estruturas” no painel administrativo do SuiteCRM e, em seguida, selecione a opção “Reconstruir Relacionamentos” e também “Reparo rápido e Reconstrução”.
    • Para mais informações, confira “Reparar Estruturas”.
17. Manualmente, mescle os arquivos que foram ignorados durante a atualização extraindo-os do pacote de atualização (arquivo zip), caso tenha desmarcado algum arquivo de forma a prevenir que o assistente o sobreesrevesse. Esta mesclagem pode ser realizada através do diretório da aplicação existente em seu servidor web.
    • Nota: Confira o arquivo LOG do assistente de atualização no diretório do SuiteCRM para obter informações sobre alguma falha ocorrida durante a atualização.

Desinstalando uma instância do SuiteCRM

Siga estes passos para desinstalar sua instância do SuiteCRM:

1. Localize o diretório do SuiteCRM em seu servidor web.
2. Remova o diretório (caso o SO for Linux: rm -r <suitedirectory> caso queira ser notificado durante a exclusão, rm -rf <suitedirectory> caso queira excluir tudo sem notificação alguma).
3. Delete o schema da base de dados SuiteCRM existente em seu servidor de banco de dados (o nome padrão é “suitecrm”, caso não tenha sido alterado durante o processo de instalação).

Análise de Incidentes e Suporte

O SuiteCRM é um sistema de código aberto. Devido a isso, por favor, não nos contate diretamente por e-mail ou telefone para obter suporte. Ao invés disso, por favor, utilize nosso fórum. Ao utilizá-lo, o conhecimento sobre a aplicação é compartilhado com todos os membros da comunidade. Nossos desenvolvedores respondem questões no fórum diariamente mas também dá a oportunidade para outros membros da comunidade contribuírem. Caso deseja obter alguma customização específica para atender alguma necessidade em seu CRM, por favor, utilize nosso formulário de contato.