> For the complete documentation index, see [llms.txt](https://docs.vrsoft.com.br/vrmaster/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.vrsoft.com.br/vrmaster/manual-do-sistema/manual-do-sistema-vr-monitoramento/manual-do-sistema-vr-pdv-admin-api-v2/instalacao-configuracao-pdv-admin-v2-servidor.md).

# Servidor

## Requisitos

* Docker
* Plugin Docker Compose

## Instalação

1. 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). 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. KONG\_PORT: define a porta utilizada para acessar a interface gráfica através do navegador KONG\_PORT\_SSL: define a porta utilizada para acessar a interface gráfica através do navegador com url segura (https).

2. Abrir o terminal na mesma pasta do aplicativo.

```

  cd ~/.vr/PdvAdmin

```

3. Executar o comando abaixo para criar uma rede para o ambiente do PDV Admin.

```

  docker network create vr-pdv-admin-net

```

4. Executar o comando para inicializar o aplicativo.

```

  docker compose up -d --build

```

5. Configuração de usuários.

* 5.1. Acessar pelo navegador a url do pdv admin conforme os dados configurados no arquivo .env, `IP_DO_SERVIDOR:GUI_PORT`
* 5.2. Já na tela de login, clique em `Entrar com o usuário administrador`

![](/files/RohqZMS8y1z8R0j9NSm2)

* 5.3. Informar a senha padrão VR.

![](/files/N2KQNrlAjz0axfwIPyec)

* 5.4. Você deverá ser direcionado para página de dashboard, clique sobre o menu `Usuários`

![](/files/QCipvtRcaOA7wkaEXFo8)

* 5.5. Já na tela de usuários clique sobre o ícone `Novo`

![](/files/TIaU1HsPRIZhwDY6Mqot)

* 5.6. Informe o nome de usuário e solicite a para que o usuário crie sua senha, em seguida clique sem `Salvar`

![](/files/DhXMYD6vFGYR6rYR5gXW)

* 5.7. Ao salvar deve liberar os campos para definir os níveis de acesso.

![](/files/UhehaaZFlv3D3Y5d7MXm)

| Administrador   | Permite usuário a gerenciar ECFs, Usuários e visualizar relatórios                                                           |
| --------------- | ---------------------------------------------------------------------------------------------------------------------------- |
| Fiscal Remoto   | Permite o usuário a visualizar o dashboard com o stream dos ECFs                                                             |
| Operador Remoto | Permite o usuário a visualizar e responder às solicitações para operações no ECF de acordo com seu nível e lojas vinculadas. |

* 6. Adicione o comando ao inicializar do sistema operacional.

```

  docker compose -f ~/.vr/PdvAdmin/docker-compose.yml up

```

Essa ação é necessário para que o serviço suba caso o servidor seja reiniciado.

## Ajuda


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.vrsoft.com.br/vrmaster/manual-do-sistema/manual-do-sistema-vr-monitoramento/manual-do-sistema-vr-pdv-admin-api-v2/instalacao-configuracao-pdv-admin-v2-servidor.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.