Instalação manual - Windows

Esta página descreve o processo de instalação manual da solução Navixy On-premise no Windows. Recomendamos usar Windows Server 2016 ou mais recente. Se desejar instalar a plataforma em qualquer outra versão do Windows, por exemplo versões desktop, você ainda pode aplicar este guia, pois os princípios básicos e o software são os mesmos. No entanto, apenas as versões Server são consideradas uma solução confiável.

A instalação totalmente manual do Navixy On-premise para Windows é fornecida para clientes que necessitam de controle total sobre o processo de instalação ou que possuam requisitos de configuração personalizados. Em geral, recomenda-se realizar uma instalação automatizada no Linux, pois é muito mais fácil e flexível não apenas para a instalação inicial, mas também para a administração e manutenção futuras. Instruções de instalação no Windows estão disponíveis para aqueles clientes que estão focados em usar este SO exclusivamente devido a requisitos corporativos ou outros motivos internos.

Embora a plataforma utilize o mesmo software de terceiros tanto no Linux quanto no Windows, a principal diferença em seu funcionamento é a forma como os serviços operam no Windows:

• Serviços Java são convertidos em serviços do Windows usando o software YAJSW.

• Nginx não é um serviço, mas um programa comum executando em segundo plano.

Para realizar a instalação, você precisa de uma conta do Windows com privilégios de administrador. Não importa se é uma conta local ou de domínio, pois a plataforma não está relacionada à infraestrutura de domínio de nenhuma forma. Você apenas precisa de direitos suficientes para instalá-la.

Instalar software pré-requisito

Baixe e instale os pré-requisitos descritos no Software do servidor documento. Essencialmente, você precisará destes componentes para colocar a plataforma em funcionamento:

• MySQL 8.0 - apenas o Server é obrigatório, os outros componentes são opcionais;

  • O Microsoft Visual C++ pode ser necessário para a instalação. O assistente de configuração notificará sobre isso.

• Java SE Development Kit 21;

• Nginx - qualquer versão recente (não precisa de instalação, apenas extraia);

Além dos componentes básicos, também é recomendado instalar o seguinte software para facilitar o trabalho posterior:

• Qualquer compactador capaz de descompactar arquivos tar.gz - por exemplo 7-Zip.

• Editor de texto avançado para trabalhar com configurações e grandes arquivos de log - por exemplo Notepad++.

É fortemente recomendado instalar software de terceiros somente a partir de recursos oficiais - preferencialmente pelos links acima. Se o software for instalado a partir de recursos não confiáveis, a operacionalidade não é garantida.

Configuração do MySQL

Após a instalação do MySQL Server, é necessário aplicar alterações em sua configuração para que a plataforma Navixy funcione corretamente com o banco de dados. A configuração é especificada em my.ini arquivo localizado no seguinte caminho:

C:\ProgramData\MySQL\MySQL Server 8.0\my.ini

Neste arquivo você precisa definir os parâmetros abaixo sob a [mysqld] seção. Se eles já estiverem presentes - altere-os de acordo.

default-time-zone='+00:00'
sql-mode="NO_ENGINE_SUBSTITUTION"
innodb_buffer_pool_size=10G

O innodb_buffer_pool_size o parâmetro é a quantidade de RAM alocada para o MySQL. É fortemente recomendado definir este parâmetro para 70% da RAM total no seu servidor (em gigabytes).

Após a configuração ser alterada, salve o arquivo e reinicie o MySQL pelo snap-in Serviços do Windows (services.msc) para aplicar as alterações.

Variáveis de ambiente

Java e MySQL bin pastas devem ser especificadas na variável de ambiente do sistema Windows PATH Estas pastas são (por padrão) as seguintes:

• C:\Program Files\Java\jdk-21\bin

• C:\Program Files\MySQL\MySQL Server 8.0\bin

A pasta de instalação do Java também deve ser adicionada à nova JAVA_HOME variável do sistema. Isto é necessário para que os serviços de backend funcionem corretamente

Os nomes das pastas podem variar de versão para versão, portanto verifique os caminhos reais primeiro.

Você pode atualizar as variáveis de ambiente com os seguintes comandos a partir da linha de comando:

setx /m Path "%PATH%;C:\Program Files\Java\jdk-21\bin;C:\Program Files\MySQL\MySQL Server 8.0\bin"
setx /m JAVA_HOME "C:\Program Files\Java\jdk-21"

Isso criará os valores necessários.

Você também pode atualizar as Path e JAVA_HOME variáveis de ambiente manualmente nas propriedades do sistema.

Como resultado, você deve ter o seguinte:

Variáveis de ambiente

Após as variáveis serem salvas, abra a linha de comando e verifique as versões dos softwares com os seguintes comandos:

mysql -V
java -version

Se as versões forem retornadas, então as variáveis estão configuradas corretamente.

Versões de software

Se você vir erros como não é reconhecido como um comando interno ou externo, verifique os caminhos que você especificou anteriormente.

Descompactar a plataforma

O pacote de distribuição Navixy é fornecido como um arquivo .tar.gz. A versão mais recente está sempre disponível para download no seguinte link:

⬇️ Baixar pacote Navixy On-premise

Coloque-o em qualquer pasta do seu servidor e extraia-o.

O pacote contém muitas pastas aninhadas, então tenha cuidado para não exceder o limite do Windows de 255 caracteres no caminho do arquivo.

Coloque a pasta navixy-package do arquivo em algum diretório como: C:\distrib\navixy-package

Doravante esta será a pasta principal da distribuição. Mais adiante nesta instrução você pode encontrar caminhos como ...navixy-package/db, o que significa que as operações devem ser realizadas a partir desta pasta e suas subpastas.

Após descompactar a plataforma e preparar todos os pré-requisitos, você está pronto para iniciar a instalação da plataforma Navixy.

Bancos de dados Navixy

Primeiro, você precisa realizar a configuração do banco de dados MySQL. Recomenda-se trabalhar com o MySQL a partir da linha de comando. Conecte-se ao MySQL como root usuário com a senha que você definiu durante a instalação do MySQL:

mysql -uroot -p

Execute o bloco de consultas abaixo. Substitua <PASSWORD> por uma nova senha para o navixy usuário, memorize-a, você precisará dela mais tarde.

CREATE USER navixy@'%' IDENTIFIED BY '<PASSWORD>' WITH MAX_QUERIES_PER_HOUR 0 MAX_UPDATES_PER_HOUR 0 MAX_CONNECTIONS_PER_HOUR 0 MAX_USER_CONNECTIONS 0;
CREATE DATABASE google CHARACTER SET utf8 COLLATE utf8_general_ci;
CREATE DATABASE tracking CHARACTER SET utf8 COLLATE utf8_general_ci;
GRANT USAGE ON *.* to navixy@'%';
GRANT ALL PRIVILEGES ON google.* TO navixy@'%';
GRANT ALL PRIVILEGES ON tracking.* TO navixy@'%';

Isto criará bancos de dados vazios para uso posterior.

Saia do MySQL e retorne à linha de comando.

Conteúdo do banco de dados

Altere o diretório na linha de comando para ...navixy-package\db.

Execute o seguinte comando para importar a estrutura das tabelas de dados de negócio:

mysql -uroot -p google < google.sql

Após isso, exclua o updates.sql e google.sql arquivos com os seguintes comandos, pois eles não são necessários na próxima etapa:

del updates.sql
del google.sql

Agora importe os arquivos restantes para o banco de dados usando este comando:

type *.sql | mysql -uroot -p google

Servidor de arquivos

Conecte-se ao MySQL novamente e execute a consulta SQL abaixo. Isso permitirá fazer upload de arquivos a partir do aplicativo móvel e da interface web para o seu servidor, o que é necessário ao trabalhar com formulários de serviço de campo, manutenção de veículos e outros recursos. Altere api.domain.com para o seu domínio da API, e altere https para http se você não utilizar SSL.

INSERT INTO google.file_storages (id, engine, config) values (1, 'local_fs', '{"base_path":"./files/","base_upload_url":"https://api.domain.com/file/upload","base_download_url":"https://api.domain.com/file/dl","secret":"s3cCr3Et","upload_credentials_ttl":"10m","is_dynamic_preview_enabled": true,"dynamic_preview_pattern":"(.+)/file/dl/(.+)","dynamic_preview_replace":"$1/file/preview/$2","security_module":{"type":"hashid","salt":"S4lTh45hV4lu3","ttl":"7d","min_length":8}}');

Os valores de secret e salt são recomendados para serem um hash aleatório de letras e números.

Chave de licença

Finalmente, aplique a chave de licença (fingerprint), que deve ser fornecida pela Navixy. Ela se parece com uma longa sequência de símbolos aleatórios.

Insira o fingerprint no banco de dados com a consulta abaixo. Altere <FINGERPRINT> para o valor recebido):

UPDATE google.variables SET value='<FINGERPRINT>' WHERE var='fingerprint';

O fingerprint é dinâmico. Ele é atualizado cada vez que seu servidor se conecta ao auth.navixy.com servidor de licenciamento. Isso ocorre a cada 3 dias e em toda inicialização dos serviços. Portanto, não é necessário armazená-lo separadamente da plataforma, pois ele está em constante alteração. Também por esse motivo você não pode usá-lo em múltiplas instâncias. A chave só pode ser usada para uma única instância do Navixy On-premise.

Frontend

O próximo passo é configurar o frontend da plataforma Navixy On-premise - configurando o servidor web Nginx e os arquivos estáticos da interface do usuário.

Create nginx pasta no disco C:.

md nginx

Copie a distribuição descompactada do Nginx para a C:\nginx.

pasta Nginx

Arquivos estáticos

Crie uma pasta chamada www em C:\nginx. Copie as pastas panel-v2 e pro-ui de navixy-package para ela. Estas são as pastas que contêm os arquivos estáticos do site Navixy - na verdade, todo o seu conteúdo visível. Agora você precisa renomear os arquivos de configuração:

• Abra \panel-v2 pasta e renomeie o arquivo PConfig.example.sa.js para PConfig.js.

• Abra \pro-ui e renomeie Config.example.sa.js para Config.js.

• Abra \pro-ui\static e renomeie app_config.example.sa.js para app_config.js.

Em todas as etapas acima, apenas remova .example.sa entrada dos nomes de arquivo. Tenha cuidado para não confundir arquivos com nomes semelhantes nas pastas.

Nginx

Adicione as linhas a seguir ao http bloco de C:\nginx\conf\nginx.conf arquivo:

include conf.d/*.conf;
server_names_hash_bucket_size 64;

Copie uma pasta chamada include from ...navixy-package\windows\nginx para C:\nginx\conf pasta.

Crie uma pasta chamada conf.d em C:\nginx\conf. Esta pasta conterá a configuração do site da plataforma.

Copie estes arquivos de ...navixy-package\windows\nginx para a recém-criada C:\nginx\conf\conf.d pasta:

• map.conf

• navixy.conf

Se você pretende usar proteção SSL em seu servidor, de modo que seu site seja aberto via HTTPS, também copie este arquivo:

• navixy_ssl.conf

Agora, configure navixy.conf e navixy_ssl.conf de acordo com a Configurações do Nginx página. Estes são os principais arquivos de configuração para o servidor web, portanto tome cuidado extra ao editá-los.

Para configurar a plataforma para funcionar via HTTPS, você precisará de um certificado SSL válido emitido para seu domínio, juntamente com sua chave privada. Na ausência do certificado e de sua chave privada correspondente, o servidor web com a opção “443 ssl” não conseguirá ser executado. Para saber mais sobre certificados SSL e seu funcionamento na plataforma, consulte Instalação de certificados SSL página.

Após tudo o que foi descrito acima ser feito - execute nginx.exe como administrador. Certifique-se de que ele esteja em execução no Gerenciador de Tarefas (normalmente possui dois ou mais processos). Se ele parar de funcionar, verifique C:\nginx\logs\error.log em busca de erros e aja de acordo.

Nginx em execução

Backend

Esta parte consiste em dois passos: configurar os serviços Java e convertê-los em serviços do Windows.

Serviços Java - pré-configuração

Create java pasta no disco C:.

md java

Copie as pastas a seguir de ...navixy-package para C:\java:

• api-server

• sms-server

• tcp-server

Em cada uma dessas pastas, mova a conf subpasta do subdiretório dist para a pasta do serviço. Use os seguintes comandos na linha de comando para facilitar isso.

move C:\java\api-server\dist\conf C:\java\api-server\
move C:\java\sms-server\dist\conf C:\java\sms-server\
move C:\java\tcp-server\dist\conf C:\java\tcp-server\

Abra cada uma das três conf subpastas uma por uma e encontre os db.properties arquivos dentro. Estes são os arquivos para configurar os serviços da plataforma para conectar-se ao banco de dados. Para garantir o funcionamento adequado de cada serviço, você precisa atualizar as credenciais de conexão do banco de dados para cada um deles. Edite as linhas a seguir nos arquivos de configuração (<PASSWORD> refere-se à senha que você criou anteriormente para o usuário "navixy")

db.username=navixy
db.password=<PASSWORD>

Se seu banco de dados estiver hospedado em um servidor separado, você também precisa alterar a linha db.connectionString nos mesmos arquivos. Especifique o endereço real do seu servidor de banco de dados em vez de localhost, mas não altere mais nada nesta string.

Serviços Java - API-server

Abra o arquivo C:\java\api-server\conf\config.properties.

Edite as seguintes linhas:

• api.externalBaseUrl= - URL do seu domínio da API (com http:// ou https:// no início). i

• feedback.toEmail=test@localhost - endereço para receber solicitações de feedback/ajuda de usuários.

• feedback.defaultFromEmail=do-not-reply@localhsot - remetente padrão dos e-mails de ajuda.

• feedback.substituteFromEmail=false - alterna se as mensagens de ajuda são enviadas do remetente padrão (false) ou do endereço de e-mail pessoal do usuário (true).

Se você não tiver um domínio dedicado para a API, seu domínio base é especificado aqui com /api anexado, por exemplo: https://meu.dominio.com/api

Serviços Java - SMS-server

Este serviço não requer configuração e utiliza as configurações padrão.

Serviços Java - TCP-server

Abra o arquivo C:\java\tcp-server\conf\config.properties.

Edite as seguintes linhas:

• externalIP=127.0.0.1 - especifique o endereço IP da sua interface do usuário em vez de 127.0.0.1.

• externalHostname=myhost.ru - especifique o domínio da sua interface do usuário em vez de myhost.ru.

As configurações acima serão usadas para ativação automática de dispositivos.

Serviços Java - convertendo para serviços do Windows

Nesta fase, é utilizado software de terceiros - chamado YAJSW (Yet Another Java Service Wrapper). Este é um freeware usado para executar aplicações Java como serviços do Windows. Mais informações podem ser encontradas na página do projeto. O software em si está incluído no pacote Navixy.

Copie a pasta denominada wrapper from ...navixy-package\windows para C:\java.

Execute a linha de comando como administrador e altere o diretório para o seguinte:

cd C:\java\wrapper\bat

Execute setenv.bat a partir deste diretório na linha de comando.

setenv.bat

Execute os seguintes comandos, um por um:

wrapper.bat -i ../conf/wrapper.api-server.conf
wrapper.bat -i ../conf/wrapper.sms-server.conf
wrapper.bat -i ../conf/wrapper.tcp-server.conf

Isto instalará os serviços Java da plataforma como serviços regulares do Windows.

Abra o arquivo "Serviços" snap-in. Você pode procurá-lo no menu Iniciar, ou simplesmente executar o seguinte no cmd:

services.msc

Role a lista de serviços e encontre os serviços Navixy recém-instalados. Inicie-os um por um.

• Navixy api-server

• Navixy sms-server

• Navixy tcp-server

Serviços Navixy no Windows

Certifique-se de que os serviços continuem funcionando ao longo do tempo - eles devem estar com o status “Running” constantemente. Se algum deles travar, verifique os logs deles para possíveis erros.

Passos finais

Acessando o painel Admin

Uma vez que tudo esteja instalado e em execução, você precisa verificar a disponibilidade do domínio do seu painel Admin no navegador. Ao especificá-lo na linha de endereço, você deve ser direcionado para a página de login. Se o domínio não o direcionar para a página correta, verifique novamente as configurações do seu servidor web para garantir que estejam corretas.

Considere alterar sua senha do painel Admin assim que efetuar login no sistema, pois as credenciais são padrão:

• nome de usuário: admin

• senha: admin

Acessando a interface do usuário

Para que a interface do usuário esteja disponível, você precisa especificar seu domínio primeiro em Admin panel → Service Preferences, conforme descrito neste documento: Nome do domínio.

Se o acima não for feito, a interface do usuário não poderá ser aberta.

Atualizações

Para atualizar o Navixy implantado em sistema Windows para a versão mais recente, consulte este documento: Atualização no Windows

Solução de problemas

Se você encontrar quaisquer problemas durante o processo de instalação ou configuração, consulte as Solução de problemas páginas para possíveis soluções.