Instalação e implantação do serviço
1. Instalação e implantação
O serviço está dockerizado, e existe uma imagem Docker em um repositório da Facephi.
docker login facephicorp.jfrog.io
usuário: username
senha: tokendocker pull facephicorp.jfrog.io/docker-pro-fphi/facephi-ine-service:#VERSION#Onde #VERSION# é o número de versão específico que se deseja baixar (por exemplo, 1.6.0).
2. docker-compose
Uma forma de implantar o serviço é criar um arquivo docker-compose.yml com o seguinte conteúdo:
version: '3.7'
services:
ine-service:
ports:
- "6982:6982"
volumes:
- ./config:/service/config
- ./logs:/service/logs
image: facephicorp.jfrog.io/docker-pro-fphi/facephi-ine-service:latest
container_name: facephi-ine-service
environment:
# Proteção JWT opcional
# - FACEPHI_INE_REST_AUTH_ENABLED=true
# - FACEPHI_INE_REST_AUTH_JWT_SECRET=shared-secret
# - FACEPHI_INE_REST_AUTH_ACCEPT_AUTHORIZATION_HEADER=true
# - FACEPHI_INE_REST_AUTH_ACCEPT_API_KEY_HEADER=true
# - FACEPHI_INE_REST_AUTH_API_KEY_HEADER_NAME=x-api-keyObserve os volumes montados no contêiner. Esses volumes são usados para armazenar os arquivos de configuração do serviço e gravar a saída do logger.
Execute o seguinte comando, dentro da pasta onde se encontra o arquivo docker-compose.yml, para implantar o serviço:
3. Configuração
O arquivo de configuração pode conter as seguintes informações:
O arquivo de configuração pode ser passado como parâmetro ao serviço. Por padrão, o serviço procurará um arquivo chamado /service/config/config.json.
A ordem de precedência da configuração é:
Variáveis de ambiente
FACEPHI_INE_REST_*config.jsonValores padrão da API definidos pelo serviço antes da inicialização
Valores internos padrão de
Rest::Manager
A autenticação JWT é opcional e está desabilitada por padrão.
Os endpoints públicos permanecem acessíveis sem autenticação:
GET /api/v1/healtheGET /api/v1/version.POST /api/v1/facial/authenticationrequer um JWT válido quando a autenticação JWT está habilitada.O serviço não expõe endpoints
GET/POST /configem tempo de execução, portanto a configuração JWT não pode ser visualizada nem modificada por meio de uma API de configuração pública.
Variáveis de ambiente JWT suportadas:
FACEPHI_INE_REST_AUTH_ENABLEDFACEPHI_INE_REST_AUTH_JWT_SECRETFACEPHI_INE_REST_AUTH_ACCEPT_AUTHORIZATION_HEADERFACEPHI_INE_REST_AUTH_ACCEPT_API_KEY_HEADERFACEPHI_INE_REST_AUTH_API_KEY_HEADER_NAME
Atualizado