Mudanças entre as edições de "Manual do Sistema VR PDV Admin API"

De VRWiki
Linha 8: Linha 8:
 
<b> Instalação </b>
 
<b> Instalação </b>
  
−
1. Baixar os arquivos de configuração do aplicativo, [https://storage.googleapis.com/linux-pdv/pdvadmin/PdvAdminV1.rar LINK DE DOWNLOAD].
+
1. Baixar os arquivos de configuração do aplicativo e extrair na pasta  <code>~/.vr</code>.
  
−
2. Extrair na pasta <code>.vr</code>, dentro da pasta padrão do usuário, os arquivos baixados.
+
  [https://storage.googleapis.com/linux-pdv/pdvadmin/PdvAdminV1.rar LINK DE DOWNLOAD].
  
 +
ou execute o comando
 +
 +
  mkdir -p ~/.vr && \
 +
  cd ~/.vr && \
 +
  wget https://storage.googleapis.com/linux-pdv/pdvadmin/PdvAdminV1.rar -O PdvAdminV1.rar && unrar x ~/.vr/PdvAdminV1.rar
 +
  rm PdvAdminV1.rar
 +
 +
Certifique-se que a pasta esteja nessa estrutura.
 
   <b>Estrutura da pasta</b>
 
   <b>Estrutura da pasta</b>
 
   ├── ./vr/
 
   ├── ./vr/
Linha 22: Linha 30:
 
   └   └   └── .env
 
   └   └   └── .env
  
−
3. Configuração do ambiente pelo arquivo <code>.env</code>
+
2. Configuração do ambiente
−
  O Arquivo <b>.env</b> serve como central de configurações para o aplicativo, armazenando as variáveis de ambiente essenciais para o seu funcionamento. Essa prática garante maior flexibilidade e segurança, permitindo que você ajuste o comportamento do sistema sem a necessidade de modificar o código diretamente.
+
 
 +
  A configuração de todo ambiente será realizada pelo arquivo <code>.env</code> que serve como ponto central de configurações para o aplicativo, armazenando as variáveis de ambiente essenciais para o seu funcionamento. Permitindo que você ajuste o comportamento do sistema sem a necessidade de modificar o código diretamente.
 
   -
 
   -
 
   <b>Principais Variáveis e suas Funcionalidades</b>
 
   <b>Principais Variáveis e suas Funcionalidades</b>
 
   -
 
   -
 
   PORT: Define a porta de comunicação com a interface do usuário (Front End).
 
   PORT: Define a porta de comunicação com a interface do usuário (Front End).
−
   SOCKET_PORT: especifica a porta de comunicação com o ponto de venda (PDV).
+
   SOCKET_PORT: especifica a porta de comunicação com o ponto de venda (PDV), utilize a porta <code>4040</code>.
 
   API_VERSION: indica a versão da API utilizada pelo sistema.
 
   API_VERSION: indica a versão da API utilizada pelo sistema.
 
   IP: Define o endereço IP do servidor onde o aplicativo PDVAdmin está instalado.
 
   IP: Define o endereço IP do servidor onde o aplicativo PDVAdmin está instalado.
Linha 34: Linha 43:
 
   GUI_VERSION: especifica a versão da interface gráfica do usuário.
 
   GUI_VERSION: especifica a versão da interface gráfica do usuário.
 
   GUI_PORT: define a porta utilizada para acessar a interface gráfica através do navegador.
 
   GUI_PORT: define a porta utilizada para acessar a interface gráfica através do navegador.
−
   -
+
    
−
  VRSOFT_PERMITE_CAMERAS: controla a habilitação do uso de câmeras. A configuração deve ser verificada com o cliente de acordo com o contrato.
 
  
 
4. Abrir o terminal na mesma pasta do arquivo <code>docker-compose.yml</code> e executar o comando:
 
4. Abrir o terminal na mesma pasta do arquivo <code>docker-compose.yml</code> e executar o comando:
  
−
   docker compose up --build
+
   docker compose up -d --build
  
  
−
<b>WIKI EM CONTRUÇÃO</b>
+
<b>WIKI EM CONSTRUÇÃO</b>
 
   Atenção esta wiki ainda esta em processo de construcao.
 
   Atenção esta wiki ainda esta em processo de construcao.

Edição das 11h59min de 4 de dezembro de 2024

Requisitos

  • Docker
  • Plugin Docker Compose

Instalação

1. Baixar os arquivos de configuração do aplicativo e extrair na pasta ~/.vr. 

 LINK DE DOWNLOAD.

ou execute o comando 

 mkdir -p ~/.vr && \
 cd ~/.vr && \
 wget https://storage.googleapis.com/linux-pdv/pdvadmin/PdvAdminV1.rar -O PdvAdminV1.rar && unrar x ~/.vr/PdvAdminV1.rar
 rm PdvAdminV1.rar

Certifique-se que a pasta esteja nessa estrutura. 

 Estrutura da pasta
 ├── ./vr/
 │   ├── PdvAdmin/
 │   │   ├── .docker/ 
 │   │   │  └── postgres/ 
 │   │   │      ├── Dockerfile
 │   │   │      └── postgresql.conf
 │   │   ├── docker-compose.yml 
 └   └   └── .env

2. Configuração do ambiente 

 A configuração de todo ambiente será realizada pelo arquivo .env que serve como ponto central de configurações para o aplicativo, armazenando as variáveis de ambiente essenciais para o seu funcionamento. Permitindo que você ajuste o comportamento do sistema sem a necessidade de modificar o código diretamente.
 -
 Principais Variáveis e suas Funcionalidades
 -
 PORT: Define a porta de comunicação com a interface do usuário (Front End).
 SOCKET_PORT: especifica a porta de comunicação com o ponto de venda (PDV), utilize a porta 4040.
 API_VERSION: indica a versão da API utilizada pelo sistema.
 IP: Define o endereço IP do servidor onde o aplicativo PDVAdmin está instalado.
 -
 GUI_VERSION: especifica a versão da interface gráfica do usuário.
 GUI_PORT: define a porta utilizada para acessar a interface gráfica através do navegador.

4. Abrir o terminal na mesma pasta do arquivo docker-compose.yml e executar o comando: 

 docker compose up -d --build


WIKI EM CONSTRUÇÃO 

 Atenção esta wiki ainda esta em processo de construcao.
Disponível em "http://wiki.vrsoft.com.br//wiki/index.php?title=Manual_do_Sistema_VR_PDV_Admin_API&oldid=46245"