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

De VRWiki
(Criou página com '<b> Requisitos </b> <ul> <li>Docker</li> </ul> <b> Instalação </b> 1. Crie ou Acesse a pasta <b>.vr</b> dentro da pasta padrão do usuário, com a seguinte estrutura de...')
 
Linha 7: Linha 7:
 
<b> Instalação </b>
 
<b> Instalação </b>
  
1. Crie ou Acesse a pasta <b>.vr</b> dentro da pasta padrão do usuário, com a seguinte estrutura de diretórios e arquivos:
+
1. Baixar os arquivos de configuração do aplicativo, [https://hub.docker.com/signup LINK DE DOWNLOAD].
  
 +
2. Extrair na pasta <code>.vr</code>, dentro da pasta padrão do usuário, os arquivos baixados. 
 +
 +
  <b>Estrutura da pasta</b>
 
   ├── ./vr/
 
   ├── ./vr/
 
   │   ├── PdvAdmin/
 
   │   ├── PdvAdmin/
Linha 18: Linha 21:
 
   └   └   └── .env
 
   └   └   └── .env
  
- [https://hub.docker.com/signup Download dos arquivo]
+
3. Configuração do ambiente pelo arquivo <code>.env</code>
 +
  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.
 +
 
 +
  <b>Principais Variáveis e suas Funcionalidades</b>
 +
  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).
 +
  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.
 +
 
 +
  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.

Edição das 12h48min de 30 de setembro de 2024

Requisitos

  • Docker

Instalação

1. Baixar os arquivos de configuração do aplicativo, LINK DE DOWNLOAD.

2. Extrair na pasta .vr, dentro da pasta padrão do usuário, os arquivos baixados.

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

3. Configuração do ambiente pelo arquivo .env

 O Arquivo .env 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.
 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).
 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.
 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.