From 6370e8f39bfcf3ebe2ca56d17712dc13f3c7a67b Mon Sep 17 00:00:00 2001 From: LS Date: Thu, 27 Mar 2025 14:49:29 -0300 Subject: [PATCH] Atualizado o README.md --- .gitignore | 3 ++- README.md | 32 ++++++++++++++++++++++++++++++-- admin_qr.png | Bin 1250 -> 0 bytes 3 files changed, 32 insertions(+), 3 deletions(-) delete mode 100644 admin_qr.png diff --git a/.gitignore b/.gitignore index 73baf91..79f62d2 100644 --- a/.gitignore +++ b/.gitignore @@ -260,5 +260,6 @@ poetry.toml pyrightconfig.json database.db +admin_qr.png -# End of https://www.toptal.com/developers/gitignore/api/python,flask \ No newline at end of file +# End of https://www.toptal.com/developers/gitignore/api/python,flask diff --git a/README.md b/README.md index 62b96f3..c4a2e1c 100644 --- a/README.md +++ b/README.md @@ -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 ``` diff --git a/admin_qr.png b/admin_qr.png deleted file mode 100644 index 270fcde8af350adea1ab24e3c350f30932056c08..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 1250 zcmV<81ReW{P) zU25z`6ojkO0zdY^EWk@??;uOMcxTd5ynsN@qoGCRq5qCF7jm80=}BC|n6ae!kf3Nz z*ZHv{{`s;0_6ZO`6j4MGMHEp)5k(YHL=i=l17&md0I)mva$DeDZVRwob_d*+eoH-9 zkINT4izuReh!RMW8Q9ztxng%*L#`K#fZHwZM*>KaT)*U5L=ojfl)bN_?bCJv+>hjm zm{6ACvhD(PrT(gC5k-{0O^HRZdkG=1J(EDlC~NU{`8S_M6j6SDEawxEfZHw}4)Db0 zfbs+E3u4;uzVTphB+9p=c#;Vy`?8n-M84N3cMT-@_C&s3+I^AaJ>_$rMHEp!K)H1j z;rZS1_4(cLwS~VeaCmQ@E5WAB zE)-bBGJ`8T5tHwK0yd%u8AjPr+7)FQ#Td0*1Bu8C0KNya{(N=lS=tq4BBg8BS79>w zOnMG+kujH$25m@8h6*Wsy zlEq`!#$u0o?bSq?N$IY^*rv5BF?kj#cbzs-kFY}86=fEsue&uM7>X_GM03XMT1*>O zNV}rUq4W%|&n_kqxb3CJ#>I36fqel&Dp_F{(*@j|CxAS%!;kbvqI?&MiFd037TDqg z=H}og&!Z{UtzE6VqRgTgkE}@)Xvv74O*0vZ<2h+plxdWsN0yB`hnL$5a#~s<%4ZPe z0Vv0qfi)_q)^3&P>C+*LEbWRii*jn-Y5p#0Ert<7&{jSwW)Nj2<>-+e#A-aUo@*OR z?keqy@(`5L)q`q}m9q2V;9_^c?Wx8LrRx&A144%CcSV^QSUF))CQ^)ITNisXZ&%zEFx1NQQE#TbnkdsK2kXG}rsaOMW+a-i(93WD)$fWj zlVV~9Q)h0a3=`X$l$vTFMVU;od$l;C2l$@#9q~c#rRcSiSL?1Q6Dj9(!&#kilsB~8 zag8HFR-dpaGbx82_byE9IE-eX_N%mBnu1AbSCk19TLalWh0`#Rs@TyOoJPyLv@6Oi zO6z?He>lW+&1HCAOjjVjE!hD+WBc9Hl}zyMnt_l{1N9#1jYRn_6g#1542!NVnCHRT zt!cI~sX?_kqD-V5a}%TD+?#>BCd~%e3-TF6nMg5vwL{jo_X(H7AM4R!l5o1oL0j%zTD1bMN8bNRa{EPo1{QsJn=-zyJUM M07*qoM6N<$f{tigL;wH)