1. Introdução¶
Esse manual descreve o procedimento de instalação e atualização dos servidores Griaule para as Aplicações Web.
Para realizar a instalação, alguns arquivos precisam estar disponíveis na máquina em que a aplicação será instalada:
- Arquivo .war da aplicação,
gbs-<app_name>-web-server-<version>.war
, que é a aplicação a ser instalada; - Pacote Apache Tomcat,
tomcats-v5.tar
, que também contém o script de setupsetup<version>.sh
; - Scripts de Pré-Instalação:
setup_webapps.sh
e, opcionalmente,setup_aliases.sh
se desejar criar Aliases.
Important
Se algum arquivo estiver faltando, entre em contato com a Equipe de Suporte da Griaule pelo e-mail: support@griaule.com.
Para fazer uma nova instalação, siga os seguintes passos:
- Verifique se o seu sistema atende aos Pré-Requisitos
- Faça a Pré-Instalação utilizando o script
- Instale o aplicativo
- Configure o aplicativo
- Verifique se o aplicativo está sendo executado por meio dos comandos apresentados em Manuseando as Aplicações
Para atualizar um aplicativo, siga as etapas:
- Verifique se o seu sistema atende aos Pré-Requisitos da nova versão
- Atualize o aplicativo através dos comandos apresentados
- Verifique as Configurações
- Verifique se o aplicativo está sendo executado por meio dos comandos apresentados em Manuseando as Aplicações
2. Pré-Requisitos¶
- Linux (CentOS 7 / Red Hat 7 / Oracle Linux 7 / Oracle Linux 8);
- Java Development Kit version 1.8+;
- Apache: Tomcat version 7+;
- Database: MySQL/MariaDB 5.7+;
- libusb, libpng12, compat-libtiff3;
- GBDS: API;
- GBDS: Matcher;
- GBDS: Notifier (somente para o ETR);
- Google Tesseract OCR Engine 4.0.0 ou maior (somente para o CardScan);
- SmartSense Agent (somente para o SmartSense)
See also
Para saber mais sobre os produtos do Griaule Biometric Suite (GBS), consulte Visão Geral do GBS.
3. Pré-Instalação¶
Alguns passos precisam ser feitos antes do processo de instalação. Essa pré-configuração é feita utilizando os scripts .sh
fornecidos.
Note
Em todos os comandos, lembre-se de substituir <app_name> para o nome da aplicação desejada.
Tip
O <app_name> pode ser: mir
, best
, etr
, cardscan
, intelligence
, bcc
, controlpanel
, or smart-sense
.
Para realizar este procedimento, execute o script de pré-instalação passando o nome da aplicação que deseja instalar:
./setup_webapps.sh <app_name>
Opcionalmente, se desejar criar aliases para facilitar o manuseio da aplicação, execute o seguinte script:
./setup_aliases.sh <app_name>
Esses scripts irão:
- Criar links simbólicos do tomcat para cada serviço
- Atualizar/modificar scripts do servidor tomcat
- Adicionar um alias para facilitar o manuseio da aplicação
Note
Após essas etapas, se o CardScan Server estiver sendo instalado, acesse o arquivo de configuração do banco de dados e adicione em [mysqld]:
vim /etc/my.cnf
# CARDSCAN Required
max_allowed_packet=500M
Se esta configuração já estiver correta, ignore este passo.
Após a conclusão dos procedimentos acima, prossiga para Instalação.
4. Instalação¶
Antes de iniciar o procedimento de instalação, certifique-se de que os arquivos tomcats-v5.tar
e o .war
da aplicação estejam disponíveis na máquina em que a aplicação será instalada.
Important
Se algum arquivo estiver faltando, entre em contato com a Equipe de Suporte da Griaule pelo e-mail: support@griaule.com.
Note
Em todos os comandos, lembre-se de substituir <app_name> para o nome da aplicação desejada e também <version> para a versão correspondente.
Tip
O <app_name> pode ser: mir
, best
, etr
, cardscan
, intelligence
, bcc
, controlpanel
, or smart-sense
.
Passo 1: Transfira e descompacte o pacote tomcats-v5.tar
no diretório /var/lib
.
tar -xf tomcats-v5.tar -C /var/lib
Passo 2: Mova o arquivo .war
da aplicação para o diretório inicial da aplicação:
mv *.war /var/lib/tomcats/<app_name>/
Passo 3: Mude para o diretório webapps
da aplicação:
cd /var/lib/tomcats/<app_name>/webapps
Passo 4: Crie um link simbólico no diretório webapps
para o arquivo .war
da aplicação.
ln -s /var/lib/tomcats/<app_name>/gbs-<app_name>-web-server-<version>.war gbs-<app_name>-server.war
Passo 5: Mude de diretório:
cd /var/lib/
Passo 6: Altere a posse dos arquivos no diretório tomcats
para o usuário tomcat
:
chown -R tomcat:tomcat tomcats/
Então, prossiga com as Configurações da aplicação.
5. Atualização¶
Para atualizar uma aplicação, prossiga com as seguintes etapas:
Note
Em todos os comandos, lembre-se de substituir <app_name> para o nome da aplicação desejada e também <version> para a versão correspondente.
Tip
O <app_name> pode ser: mir
, best
, etr
, cardscan
, intelligence
, bcc
, controlpanel
, or smart-sense
.
Passo 1: Pare a aplicação:
systemctl stop tomcat@<app_name>.service
Passo 2: Remova os arquivos antigos:
sudo rm -rf /var/lib/tomcats/<app_name>/webapps/*
Passo 3: Coloque o arquivo .war
da aplicação no diretório inicial da aplicação:
mv *.war /var/lib/tomcats/<app_name>/
Passo 4: Mude para o diretório webapps
da aplicação:
cd /var/lib/tomcats/<app_name>/webapps
Passo 5: Crie um link simbólico no diretório webapps
para o arquivo .war
da aplicação:
ln -s /var/lib/tomcats/<app_name>/gbs-<app_name>-web-server-<version>.war gbs-<app_name>-server.war
Passo 6: Inicie a aplicação:
systemctl start tomcat@<app_name>.service
Passo 7: Execute o script de setup:
/var/lib/tomcats/setup<version>.sh <app_name>
6. Configurações¶
Cada componente tem sua configuração individual. Esses são apresentados em seu respectivo manual.
Note
Em todos os comandos, lembre-se de substituir <app_name> para o nome da aplicação desejada e também <version> para a versão correspondente.
Tip
O <app_name> pode ser: mir
, best
, etr
, cardscan
, intelligence
, bcc
, controlpanel
, or smart-sense
.
Passo 1: Edite o arquivo config.properties
:
vim /var/lib/tomcats/<app_name>/conf/config.properties
ou com o alias:
etrconf
csconf
bestconf
intelconf
mirconf
bccconf
cpconf
Para entender os procedimentos de configuração, consulte o manual de configuração específico:
- Manual de Configuração do ETR Web Server
- Manual de Configuração do Cardscan Web Server
- Manual de Configuração do BEST Web Server
- Manual de Configuração do Intelligence Web Server
- Manual de Configuração do MIR Web Server
- Manual de Configuração do BCC Web Server
- Manual de Configuração do Control Panel Web Server
- Manual de Configuração do SmartSense Server
Note
Certifique-se de que os parâmetros de configuração <app_name>.ip
e <app_name>.port
estão especificados corretamente no arquivo config.properties
.
Note
Certifique-se de que o parâmetro de configuração Connector port=<port_number>
está especificado corretamente no arquivo server.xml
. Para mais informações, consulte os manuais de configuração específicos para cada aplicação.
Passo 2: Após os procedimentos de configuração, entre no MySQL como root:
mysql -u root -p
Passo 3: Rode a seguinte query:
SET GLOBAL sql_mode=(SELECT REPLACE(@@sql_mode,'ONLY_FULL_GROUP_BY',''));
Passo 4: Saia do MySQL:
exit
Passo 5: Então, inicie a aplicação.
systemctl start tomcat@<app_name>.service
ou com o alias:
<app_name> start
Passo 6: Se for a primeira vez rodando a aplicação, execute o script de setup:
/var/lib/tomcats/setup<version>.sh <app_name>
ou com o alias:
etrsetup etr
cssetup cardscan
bestsetup best
intelsetup intelligence
mirsetup mir
bccsetup bcc
cpsetup controlpanel
Important
Se estiver instalando o SmartSense, certifique-se de que o ELK também esteja instalado. Para mais instruções, consulte o Manual de Instalação do Elastic Stack (ELK).
7. Manuseando as Aplicações¶
Essa seção apresenta alguns comandos para monitorar e manusear os serviços Griaule, assim como seus respectivos aliases.
7.1. Aliases¶
Aliases são comandos curtos definidos pelo usuário que servem como substitutos para comandos mais longos ou complexos. Eles são criados para tornar os comandos frequentemente utilizados mais convenientes de executar. Quando um alias é invocado, ele é substituído pelo comando completo que representa antes de ser executado.
Se não estiver utilizando o script setup_aliases.sh
, como descrito em Pré-Instalação, é possível adicionar os aliases manualmente. Para fazer isso, edite o arquivo .bashrc
raiz:
vim /root/.bashrc
E adicione os seguintes alises, de acordo com a aplicação desejada:
Important
Para cada alias de setup de aplicação, <app_name>setup
, certifique-se de substituir <version> para a versão do script de setup disponível em /var/lib/tomcats/
na máquina em que a aplicação está sendo instalada.
setup2.2.sh
, o alias deve ser:alias etrsetup='/var/lib/tomcats/setup2.2.sh'
^^^ ^^^
# ETR
alias etrstart='systemctl start tomcat@etr.service'
alias etrstop='systemctl stop tomcat@etr.service'
alias etrstatus='systemctl status tomcat@etr.service'
alias etrhome='cd /var/lib/tomcats/etr'
alias etrconf='vim /var/lib/tomcats/etr/conf/config.properties'
alias etrsetup='/var/lib/tomcats/setup<version>.sh'
alias etrlogt='journalctl -u tomcat@etr -f'
alias etrlog='journalctl -u tomcat@etr | less'
# CARDSCAN
alias csstart='systemctl start tomcat@cardscan.service'
alias csstop='systemctl stop tomcat@cardscan.service'
alias csstatus='systemctl status tomcat@cardscan.service'
alias cshome='cd /var/lib/tomcats/cardscan'
alias csconf='vim /var/lib/tomcats/cardscan/conf/config.properties'
alias cssetup='/var/lib/tomcats/setup<version>.sh'
alias cslogt='journalctl -u tomcat@cardscan -f'
alias cslog='journalctl -u tomcat@cardscan | less'
# BEST
alias beststart='systemctl start tomcat@best.service'
alias beststop='systemctl stop tomcat@best.service'
alias beststatus='systemctl status tomcat@best.service'
alias besthome='cd /var/lib/tomcats/best'
alias bestconf='vim /var/lib/tomcats/best/conf/config.properties'
alias bestsetup='/var/lib/tomcats/setup<version>.sh'
alias bestlogt='journalctl -u tomcat@best -f'
alias bestlog='journalctl -u tomcat@best | less'
# INTELLIGENCE
alias intelstart='systemctl start tomcat@intelligence.service'
alias intelstop='systemctl stop tomcat@intelligence.service'
alias intelstatus='systemctl status tomcat@intelligence.service'
alias intelhome='cd /var/lib/tomcats/intelligence'
alias intelconf='vim /var/lib/tomcats/intelligence/conf/config.properties'
alias intelsetup='/var/lib/tomcats/setup<version>.sh'
alias intellogt='journalctl -u tomcat@intelligence -f'
alias intellog='journalctl -u tomcat@intelligence | less'
# MIR
alias mirstart='systemctl start tomcat@mir.service'
alias mirstop='systemctl stop tomcat@mir.service'
alias mirstatus='systemctl status tomcat@mir.service'
alias mirhome='cd /var/lib/tomcats/mir'
alias mirconf='vim /var/lib/tomcats/mir/conf/config.properties'
alias mirsetup='/var/lib/tomcats/setup<version>.sh'
alias mirlogt='journalctl -u tomcat@mir -f'
alias mirlog='journalctl -u tomcat@mir | less'
# BCC
alias bccstart='systemctl start tomcat@bcc.service'
alias bccstop='systemctl stop tomcat@bcc.service'
alias bccstatus='systemctl status tomcat@bcc.service'
alias bcchome='cd /var/lib/tomcats/bcc'
alias bccconf='vim /var/lib/tomcats/bcc/conf/config.properties'
alias bccsetup='/var/lib/tomcats/setup<version>.sh'
alias bcclogt='journalctl -u tomcat@bcc -f'
alias bcclog='journalctl -u tomcat@bcc | less'
# CONTROL PANEL
alias cpstart='systemctl start tomcat@controlpanel.service'
alias cpstop='systemctl stop tomcat@controlpanel.service'
alias cpstatus='systemctl status tomcat@controlpanel.service'
alias cphome='cd /var/lib/tomcats/controlpanel'
alias cpconf='vim /var/lib/tomcats/controlpanel/conf/config.properties'
alias cpsetup='/var/lib/tomcats/setup<version>.sh'
alias cplogt='journalctl -u tomcat@controlpanel -f'
alias cplog='journalctl -u tomcat@controlpanel | less'
# SMARTSENSE
alias smartstart='systemctl start tomcat@smart-sense.service'
alias smartstop='systemctl stop tomcat@smart-sense.service'
alias smartstatus='systemctl status tomcat@smart-sense.service'
alias smarthome='cd /var/lib/tomcats/smart-sense'
alias smartconf='vim /var/lib/tomcats/smart-sense/conf/config.properties'
alias smartsetup='/var/lib/tomcats/setup<version>.sh'
alias smartlogt='journalctl -u tomcat@smart-sense -f'
alias smartlog='journalctl -u tomcat@smart-sense | less'
7.2. Comandos Úteis¶
- Iniciar a Aplicação
systemctl start tomcat@etr.service
systemctl start tomcat@cardscan.service
systemctl start tomcat@best.service
systemctl start tomcat@intelligence.service
systemctl start tomcat@mir.service
systemctl start tomcat@bcc.service
systemctl start tomcat@controlpanel.service
systemctl start tomcat@smart-sense.service
ou com o alias:
etrstart
csstart
beststart
intelstart
mirstart
bccstart
cpstart
smartstart
- Parar a Aplicação
systemctl stop tomcat@etr.service
systemctl stop tomcat@cardscan.service
systemctl stop tomcat@best.service
systemctl stop tomcat@intelligence.service
systemctl stop tomcat@mir.service
systemctl stop tomcat@bcc.service
systemctl stop tomcat@controlpanel.service
systemctl stop tomcat@smart-sense.service
ou com o alias:
etrstop
csstop
beststop
intelstop
mirstop
bccstop
cpstop
smartstop
- Checar o Status da Aplicação
systemctl status tomcat@etr.service
systemctl status tomcat@cardscan.service
systemctl status tomcat@best.service
systemctl status tomcat@intelligence.service
systemctl status tomcat@mir.service
systemctl status tomcat@bcc.service
systemctl status tomcat@controlpanel.service
systemctl status tomcat@smart-sense.service
ou com o alias:
etrstatus
csstatus
beststatus
intelstatus
mirstatus
bccstatus
cpstatus
smartstatus
- Checar os Logs da Aplicação
# tail log
journalctl -u tomcat@etr -f
journalctl -u tomcat@cardscan -f
journalctl -u tomcat@best -f
journalctl -u tomcat@intelligence -f
journalctl -u tomcat@mir -f
journalctl -u tomcat@bcc -f
journalctl -u tomcat@controlpanel -f
journalctl -u tomcat@smart-sense -f
# full log
journalctl -u tomcat@etr | less
journalctl -u tomcat@cardscan | less
journalctl -u tomcat@best | less
journalctl -u tomcat@intelligence | less
journalctl -u tomcat@mir | less
journalctl -u tomcat@bcc | less
journalctl -u tomcat@controlpanel | less
journalctl -u tomcat@smart-sense | less
ou com o alias:
# tail log
etrlogt
cslogt
bestlogt
intellogt
mirlogt
bcclogt
cplogt
smartlogt
# full log
etrlog
cslog
bestlog
intellog
mirlog
bcclog
cplog
smartlog