sol7/bim-gateway repository overview

⁠BIMGateway

BIMGateway é uma ferramenta BIMachine para extração de dados que proporciona um link direto e seguro entre a plataforma.
Com ele, os dados são extraídos localmente, comprimidos, criptografados e enviados para a plataforma BIMachine, eliminando a necessidade do uso de NAT, ou VPN.

⁠Imagem base do BIMGateway

As imagens do BIMGateway utilizam como base CentOS Linux release 7.9.2009 (Core).
Novas imagens são lançadas seguindo o versionamento da plataforma BIMachine, sendo latest a versão mais atual, compatível com a versão corrente da plataforma.

⁠Processo de Instalação

O serviço do BIMGateway pode ser criado de duas formas, via terminal utilizando docker run ou através do docker compose. Ambos os processos estão descritos abaixo.

⁠Instalação com Docker (docker run)

Para execução do serviço crie o diretório "bim-gateway" e a partir dele execute no terminal o seguinte comando:

docker run -dit \
    --name bim-gateway \
    --restart=always \
    -p 8080:8080 \
    -v "$(pwd)"/.data:/app/.data \
    sol7/bim-gateway:latest

A execução deste comando no terminal realizará o download da versão mais atual do BIMGateway, criará os arquivos de configurações do serviço na pasta “.data” e disponibilizará o serviço na porta 8080 da máquina local. Estas são as configurações padrão do serviço. As mesmas podem ser modificadas de acordo com a necessidade.

ATENÇÃO:

⁠Instalação com Docker Compose

Crie o arquivo docker-compose.yml seguindo o modelo apresentado abaixo.

services:
  bim-gateway:
    image: sol7/bim-gateway:latest
    restart: always
    volumes:
      - .data:/app/.data
    ports:
      - 8080:8080

Neste arquivo, serão definidas as propriedades do serviço que será criado, como versão e porta onde o mesmo ficará acessível. Estas são as configurações padrão do serviço. As mesmas podem ser modificadas de acordo com a necessidade.

ATENÇÃO:

Dentro do diretório em que foi criado o arquivo “docker-compose.yml”, execute o seguinte comando:

docker-compose up -d

Isso criará o container do BIMGateway disponibilizando-o localmente na porta definida nas configurações.

⁠Processo de Atualização

O processo de atualização do serviço é simples, porém varia de acordo com o processo utilizado na criação do container.

⁠Atualização com Docker (docker run)

Para atualizar o serviço do BIMGateway criado a partir do comando docker run, acesse o diretório onde estão os arquivos de configuração do serviço.

ATENÇÃO:

Estando no diretório, destrua o container antigo e repita o mesmo processo utilizado na instalação do serviço.

⁠Atualização com Docker compose

Para atualizar o serviço do BIMGateway criado a partir do Docker Compose, acesse o diretório onde está o arquivo e execute os comandos abaixo.

docker-compose pull
docker-compose up -d --force-recreate

Isso fará o download da última versão disponível da imagem do serviço "BIMGateway" e recriará o container com a versão atualizada do serviço.

⁠Utilizando o BIMGateway para extração de arquivos .csv

Caso você possua arquivos no formato .csv (ou em outro formato suportado pela plataforma), é possível utilizar o BIMGateway para enviar esses arquivos de forma automatizada, sem a necessidade de fazer o upload manualmente, ou em substituição a um serviço FTP.

Para que o serviço do BIMGateway possa acessar seus arquivos, é preciso conceder acesso à eles. Isso pode ser feito através do mapeamento de uma pasta local com o contêiner, para isso, utilize os seguintes exemplos no processo de instalação ou atualização do serviço:

Docker run:

docker run -dit \
    --name bim-gateway \
    --restart=always \
    -p 8080:8080 \
    -v "$(pwd)"/.data:/app/.data \
    -v /caminho/da/pasta:/files \
    sol7/bim-gateway:latest

Docker Compose:

services:  
  bim-gateway:
    image: sol7/bim-gateway:latest
    restart: always
    volumes: 
      - .data:/app/.data
      - /caminho/da/pasta:/files
    ports: 
      - 8080:8080  

Onde “/caminho/da/pasta”, representa o caminho da pasta local na máquina onde o BIMGateway encontra-se em execução.

Caso esteja substituindo um serviço de FTP, você deve executar o BIMGateway na mesma máquina do serviço FTP ou compartilhar o diretório dos seus arquivos com o BIMGateway pela rede, seguindo a documentação do seu “sistema operacional”. Para outros exemplos de compartilhamento de volumes com o docker consulte a documentação clicando aqui⁠.

⁠Variáveis de ambiente

extractorConfig.url (Opcional): Define o endereço da plataforma BIMachine utilizado para a conexão com o BIMGateway. Por padrão, aponta para o endereço "https://app.bimachine.com⁠".

⁠Acessando o BIMGateway

Para acessar o BIMGateway, basta acessar o link http://<IP_DA_MAQUINA_HOST>:8080 ou caso o serviço esteja configurado em uma porta customizada , http://<IP_DA_MAQUINA_HOST>:<PORTA>.

A partir da tela de login, acesse o serviço utilizando as mesmas credenciais do seu usuário da plataforma BIMachine e siga o passo a posso descrito aqui⁠ para realizar a criação da conexão entre a plataforma e o BIMGateway.

⁠Imagens

As imagens disponibilizadas do BIMGateway seguem o mesmo versionamento da plataforma BIMachine, sendo latest a versão corrente da aplicação. Caso necessário a utilização de uma versão diferente, a lista completa de imagens está disponível aqui⁠.

⁠Duvidas, Problemas ou sugestões

Se possuir alguma dúvida quanto a utilização da imagem, sugestão de melhoria ou caso encontre algum problema no uso, entre em contato conosco através do nosso canal de suporte⁠.

Para informações referentes ao uso do BIMGateway em seu projeto, acesse a documentação na nossa base de conhecimento clicando aqui⁠.