> For the complete documentation index, see [llms.txt](https://software-telematica-com.gitbook.io/suricato-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://software-telematica-com.gitbook.io/suricato-docs/central-tecnica/instalacao-e-configuracao-do-suricato/instalacao-do-suricato.md).

# Instalação do Suricato

## Visão Geral

A implantação consiste em preparar o servidor e os arquivos do sistema. O fluxo de instalação é padrão, porém a versão 3.1 exige uma preparação prévia de limpeza do ambiente.

{% hint style="warning" %}

#### Atenção: Atualização de Requisitos (Versão 3.1)

Para garantir a performance e segurança da nova interface 3.1, as versões de servidor e PHP foram atualizadas. Certifique-se de que o seu ambiente atende aos novos requisitos mínimos:

* [PHP: **8.5.0**](/suricato-docs/central-tecnica/instalacao-e-configuracao-do-suricato/instalacao-do-suricato/atualizacao-do-php.md)
* [Servidor Web: Apache HTTP Server **2.4.66.0** ou **IIS 10**.](/suricato-docs/central-tecnica/instalacao-e-configuracao-do-suricato/instalacao-do-suricato/instalacao-e-atualizacao-do-apache/atualizacao-do-apache.md)
  {% endhint %}

## Regra de Negócio

* **Atualização obrigatória (v3.1):** Para atualizar da versão 3.0.0.0 para a 3.1.0, é necessário estar previamente na versão **3.0.0.25**.
* **Acesso:** É necessário executar a instalação com privilégios de administrador.
* **Diretório de instalação:** O caminho padrão é `C:\Program Files\Telematica`.
* **Versão 3.1:** O diretório deve estar **limpo (sem arquivos de instalações anteriores)**.
* **Licença:** A instalação só prossegue com chave válida.
* **Webservice:** Pode ser configurado com **IIS ou Apache**.
* **Rede:** A porta HTTPS (padrão 443) deve estar disponível.

## Como Instalar o Suricato <a href="#regras-de-negocio" id="regras-de-negocio"></a>

<figure><img src="https://235558800-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fjphwa3C6HguhCU8RfNQR%2Fuploads%2FvgwUsYuWY3R8CvFPqjSu%2Fimage.png?alt=media&amp;token=fb95cdeb-f366-4d41-8d58-4c87ebcebbaf" alt=""><figcaption></figcaption></figure>

#### Siga as etapas abaixo, observando os alertas específicos para a versão 3.1:

{% stepper %}
{% step %}
**Idioma e Termos**

Selecione o idioma e aceite os termos de consentimento.
{% endstep %}

{% step %}
**Chave Serial**

Insira a chave fornecida para validar a licença.

<figure><img src="https://235558800-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fjphwa3C6HguhCU8RfNQR%2Fuploads%2F1rvMulFX5sGSAcACC8eD%2Fimage.png?alt=media&amp;token=6c3de360-5c48-4e30-ac93-def83d0df07d" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}
**Banco de Dados**

* MSSQL (recomendado)
* Oracle
  {% endstep %}

{% step %}
**Webservice**

IIS ou Apache.

<figure><img src="https://235558800-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fjphwa3C6HguhCU8RfNQR%2Fuploads%2FiD0sgo5vnL8dLf4jlNEo%2Fimage.png?alt=media&amp;token=55c8f5ef-ef3d-4d25-b1e3-0d529b1e21ff" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}
**Destino e Componentes**

Defina o diretório (Padrão: `C:\Program Files\Telematica`).

* *<mark style="color:$primary;">**Nota para v3.1:**</mark>* O instalador deve encontrar este diretório vazio (pasta antiga renomeada).
  {% endstep %}

{% step %}
**Selecione os componentes necessários**

* Ponto
* Middleware
* TOTVS
* (Oracle) Serviço Gerenciador
* (Oracle) Matriz de Acesso
  {% endstep %}

{% step %}
Clique em **Instalar** e aguarde.

<div align="left"><figure><img src="https://235558800-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fjphwa3C6HguhCU8RfNQR%2Fuploads%2FsXUJhavo6nxiN4W6L3e8%2Fimage.png?alt=media&amp;token=33237352-a606-4f88-a3f0-8351e6461913" alt=""><figcaption></figcaption></figure></div>
{% endstep %}
{% endstepper %}

### Configuração da Porta HTTPS

{% stepper %}
{% step %}
Após a instalação dos arquivos, configure os parâmetros de rede.

* Porta padrão: **443**
* Clique em **Testar**

<figure><img src="https://235558800-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fjphwa3C6HguhCU8RfNQR%2Fuploads%2FFrLsakqHiOdADl7H2jsD%2Fimage.png?alt=media&amp;token=d2d109a5-6b6b-46e4-99fe-63e31ed890e2" alt=""><figcaption><p><em>Tela - Teste Porta HTTPS</em></p></figcaption></figure>
{% endstep %}

{% step %}
**Verifique a liberação da Porta**

* Clicando no botão "Testar" será retornando uma das seguintes imagens:
* **Porta Liberada:** caso a porta esteja disponível
* **Porta está em uso**: caso a porta esteja indiponível, e o botão para prosseguir será desabilitado

<div><figure><img src="https://235558800-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fjphwa3C6HguhCU8RfNQR%2Fuploads%2FQDfKlPWa5QGZ81ahcV4g%2Fimage.png?alt=media&amp;token=c392c976-29bd-4c9a-b8bd-723abd1f7eb0" alt=""><figcaption><p><em>Tela - Mensagens Porta em uso</em></p></figcaption></figure> <figure><img src="https://235558800-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fjphwa3C6HguhCU8RfNQR%2Fuploads%2F1go31XFYhAw4wBdEioQE%2Fimage.png?alt=media&amp;token=e8572f17-9b2b-4dbb-99d7-4f279446523e" alt=""><figcaption><p><em>Tela - Mensagens Porta liberada</em></p></figcaption></figure></div>

{% hint style="info" %}
**Nota:** Os parâmetros abaixo variam conforme o banco de dados selecionado (SQL Server ou Oracle).
{% endhint %}
{% endstep %}
{% endstepper %}

### Configuração para realizar a conexão com o Banco de Dados:

{% stepper %}
{% step %}
**Servidor HTTPS**

IP da Maquina que executará o Suricato
{% endstep %}

{% step %}
**Servidor BD**

* **SQL Server:** IP do servidor SQL Server
* **Oracle:** IP do servidor Oracle
  {% endstep %}

{% step %}
**Porta**

* SQL Server: **1433**
* Oracle: **1521**
  {% endstep %}

{% step %}
**Nome do banco**

* **SQL** - Nome do Banco de Dados (SURICATO).
* **ORACLE** - Nome do banco de dados (SURICATO). Defina se a conexão será realizada via *SERVICE* ou *SID*.
  * Para **SERVICE**, informe o nome do serviço configurado no Oracle.
  * Já para **SID**, é obrigatório informá-lo explicitamente.
  * Exemplo de conexão com o banco SURICATO:
    * Via SID: **"SID:SURICATO"**
    * Via SERVICE: **"SURICATO"**
      {% endstep %}

{% step %}
**Instância**

Instância do Banco de Dados, caso não possua deixar em branco.

<figure><img src="https://235558800-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fjphwa3C6HguhCU8RfNQR%2Fuploads%2Fe3ZyDTpknAs7jsnd5uG9%2Fimage.png?alt=media&amp;token=4389843b-f197-4995-a4ac-88b494dd356b" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}
**Após a parametrização**

Execute os scripts respeitando a ordem das pastas:

* **Se v3.0:** Execute as pastas **1 → 2 → 3.**
* **Se v3.1:** Execute as pastas **1 → 2 → 3 → 4.**
  * *A pasta 4 é vital para o funcionamento das novas tabelas da **3.1***
    {% endstep %}
    {% endstepper %}

## Próximos passos

A partir daqui inicia-se a configuração do Banco de dados, dos Serviços, Modulos e a Validação do Sistema.

#### Banco de Dados

<table data-card-size="large" data-view="cards"><thead><tr><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><mark style="color:$primary;"><strong>Configuração SGDB SQL Server</strong></mark></td><td><a href="/suricato-docs/central-tecnica/instalacao-e-configuracao-do-suricato/instalacao-do-suricato/instalacao-suricato-em-sql.md">Instalação Suricato em SQL</a></td></tr><tr><td><mark style="color:$primary;"><strong>Configuração SGDB Oracle</strong></mark></td><td><a href="/suricato-docs/central-tecnica/instalacao-e-configuracao-do-suricato/instalacao-do-suricato/instalacao-suricato-em-oracle.md">Instalação Suricato em Oracle</a></td></tr></tbody></table>

#### Servidor Web / Aplicação

<table data-view="cards"><thead><tr><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><mark style="color:$primary;"><strong>Configuração SURICATO IIS</strong></mark></td><td><a href="/suricato-docs/central-tecnica/instalacao-e-configuracao-do-suricato/instalacao-do-suricato/configuracao-suricato-iis.md">Configuração Suricato IIS</a></td></tr><tr><td><mark style="color:$primary;"><strong>Instalação do Serviço Apache Manualmente</strong></mark></td><td><a href="/suricato-docs/central-tecnica/instalacao-e-configuracao-do-suricato/instalacao-do-suricato/instalacao-e-atualizacao-do-apache.md">Instalação e Atualização do Apache</a></td></tr><tr><td><mark style="color:$primary;"><strong>Atualização PHP</strong></mark></td><td><a href="/suricato-docs/central-tecnica/instalacao-e-configuracao-do-suricato/instalacao-do-suricato/atualizacao-do-php.md">Atualização do PHP</a></td></tr></tbody></table>

#### Serviços do Sistema

<table data-card-size="large" data-view="cards"><thead><tr><th></th><th data-hidden data-card-target data-type="content-ref"></th><th data-hidden data-card-cover data-type="image">Cover image</th></tr></thead><tbody><tr><td><mark style="color:$primary;"><strong>⚙️ Instalação e Configuração do Serviço Conex e ConexRep Manualmente</strong></mark></td><td><a href="/suricato-docs/conex/conex/instalacao-dos-servicos-conex-e-conexrep.md">Instalação dos Serviços Conex e ConexREP</a></td><td></td></tr><tr><td><mark style="color:$primary;"><strong>⚙️ Instalação e Configuração do Gerenciador de Serviços GerServ</strong></mark></td><td><a href="/suricato-docs/central-tecnica/instalacao-e-configuracao-de-servicos-e-funcionalidades/instalacao-e-configuracao-do-gerserv.md">Instalação e Configuração do GerServ</a></td><td></td></tr><tr><td><mark style="color:$primary;"><strong>⚙️ Instalação do Serviço Suricato Client</strong></mark></td><td><a href="/suricato-docs/central-tecnica/instalacao-e-configuracao-de-servicos-e-funcionalidades/instalacao-e-configuracao-do-suricato-client.md">Instalação e Configuração do Suricato Client</a></td><td></td></tr><tr><td><mark style="color:$primary;"><strong>⚙️ Instalação e configuração do ConexX</strong></mark></td><td><a href="/suricato-docs/conex/conexx-e-xt.md">ConexX e XT</a></td><td></td></tr></tbody></table>

#### Módulos e Componentes Adicionais

<table data-view="cards"><thead><tr><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><mark style="color:$primary;"><strong>Instalação e Configuração do Middleware</strong></mark></td><td><a href="/suricato-docs/central-tecnica/instalacao-e-configuracao-de-servicos-e-funcionalidades/instalacao-e-configuracao-do-servico-middleware.md">Instalação e Configuração do Serviço Middleware</a></td></tr><tr><td><mark style="color:$primary;"><strong>Instalação e Configuração do Suricato REP</strong></mark></td><td><a href="/suricato-docs/central-tecnica/instalacao-e-configuracao-de-servicos-e-funcionalidades/instalacao-e-configuracao-do-suricato-rep.md">Instalação e Configuração do Suricato REP</a></td></tr><tr><td><mark style="color:$primary;"><strong>Instalação e Configuração do Suricato Player</strong></mark></td><td><a href="/suricato-docs/central-tecnica/instalacao-e-configuracao-de-servicos-e-funcionalidades/instalacao-servico-suriplayer.md">Instalação Serviço SuriPlayer</a></td></tr><tr><td><mark style="color:$primary;"><strong>Instalação e Configuração do Suricato Face</strong></mark></td><td><a href="/suricato-docs/central-tecnica/instalacao-e-configuracao-de-servicos-e-funcionalidades/instalacao-e-configuracao-do-suricato-face.md">Instalação e Configuração do Suricato Face</a></td></tr><tr><td><mark style="color:$primary;"><strong>Instalação e configuração do Suricato Placa</strong></mark></td><td><a href="/suricato-docs/central-tecnica/instalacao-e-configuracao-de-servicos-e-funcionalidades/instalacao-e-configuracao-do-suricato-placa.md">Instalação e Configuração do Suricato Placa</a></td></tr></tbody></table>

#### Integrações

<table data-card-size="large" data-view="cards"><thead><tr><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><mark style="color:$primary;"><strong>Integração SURICATO e TOTVS</strong></mark></td><td><a href="/suricato-docs/central-tecnica/instalacao-e-configuracao-do-suricato/instalacao-do-suricato/integracao-suricato-totvs.md">Integração SURICATO TOTVS</a></td></tr></tbody></table>

#### Validação e Testes

<table data-card-size="large" data-view="cards"><thead><tr><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><mark style="color:$primary;"><strong>Validação do Software</strong></mark></td><td><a href="/suricato-docs/central-tecnica/instalacao-e-configuracao-do-suricato/instalacao-do-suricato/validacao-do-software.md">Validação do Software</a></td></tr></tbody></table>

## FAQ - Perguntas Frequentes

<details>

<summary>Posso instalar direto da 3.0.0.0 para 3.1?</summary>

Não. É obrigatório passar pela versão 3.0.0.25.

</details>

<details>

<summary>Preciso limpar a pasta na versão 3.0?</summary>

Não é obrigatório. Essa exigência é específica da versão 3.1.

</details>

<details>

<summary>Qual webservice devo escolher?</summary>

IIS ou Apache, depende do padrão do ambiente.

</details>

<details>

<summary>O que acontece se a porta 443 estiver ocupada?</summary>

A instalação não permite prosseguir até que a porta seja liberada ou alterada.

</details>

<details>

<summary>Quais componentes devo instalar?</summary>

Depende do ambiente, mas normalmente Acesso, Ponto, Middleware e TOTVS são os mais utilizados.

</details>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://software-telematica-com.gitbook.io/suricato-docs/central-tecnica/instalacao-e-configuracao-do-suricato/instalacao-do-suricato.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.