Atualizado o README.md

This commit is contained in:
LS
2025-03-27 14:49:29 -03:00
parent bae6b1ae14
commit 6370e8f39b
3 changed files with 32 additions and 3 deletions

View File

@@ -1,4 +1,4 @@
# controles
# Sistema de Controles
## Para instalar
@@ -6,9 +6,37 @@
make install
```
## Para executar
## Sobre o QR Code de Autenticação (admin_qr.png)
O arquivo `admin_qr.png` é um QR code gerado automaticamente para configuração da autenticação de dois fatores (2FA) do usuário administrador. Este arquivo é:
- Gerado na raiz do projeto quando:
- O comando `make reset-admin` é executado
- O servidor é iniciado com `make run` e existe um usuário admin
- Um novo usuário é criado através da interface web
- Usado para:
- Configurar a autenticação 2FA no aplicativo autenticador (Google Authenticator, Microsoft Authenticator, etc.)
- Gerar os códigos OTP necessários para fazer login no sistema
### Importante:
- O QR code é atualizado sempre que um novo usuário é criado ou quando o sistema é reiniciado
- Cada QR code é único e corresponde ao segredo OTP atual do usuário
- Se você recriar o banco de dados ou resetar o admin, será necessário reconfigurar o aplicativo autenticador com o novo QR code
- Mantenha este arquivo seguro, pois ele contém informações sensíveis de autenticação
### Como usar:
1. Instale um aplicativo autenticador no seu celular (Google Authenticator, Microsoft Authenticator, etc.)
2. Escaneie o QR code (`admin_qr.png`) com o aplicativo
3. O aplicativo irá gerar códigos de 6 dígitos a cada 30 segundos
4. Use estes códigos junto com seu usuário e senha para fazer login no sistema
### Comandos relacionados:
```bash
# Limpar banco e criar novo admin com novo QR code
make reset-admin
# Iniciar o servidor (também gera novo QR code se necessário)
make run
```