From d3d89291a4098467dfb274d25ac7830979d72a15 Mon Sep 17 00:00:00 2001 From: Tiago Date: Sat, 29 Nov 2025 20:53:49 -0300 Subject: [PATCH] Add README with clone and docker instructions --- README.md | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..f2ad462 --- /dev/null +++ b/README.md @@ -0,0 +1,32 @@ +# Dashboard Telseg + +Instruções rápidas para clonar o repositório e subir o ambiente via Docker. + +## Como clonar +- Via HTTPS: `git clone https://gitea.notetec.xyz/tiago/Dashboard.git` +- Se o repositório for privado, use seu usuário e senha/token: + `git clone https://:@gitea.notetec.xyz/tiago/Dashboard.git` + +## Como subir com Docker +1. Entre na pasta do projeto: `cd Dashboard` +2. (Opcional) Crie um `.env` na raiz para ajustar variáveis usadas pelo `docker-compose.yml`: + ```env + POSTGRES_DB=telseg + POSTGRES_USER=telseg + POSTGRES_PASSWORD=telseg + JWT_SECRET=troque_este_valor + ADMIN_USER=admin + ADMIN_PASSWORD=admin123 + ``` + Se não criar o `.env`, esses valores padrão serão usados. +3. Suba os serviços: `docker compose up -d --build` +4. Verifique se está tudo de pé: `docker compose ps` + +## Acessos e portas +- Dashboard: http://localhost:4242 +- Adminer (banco): http://localhost:8081 — host `db`, usuário `telseg`, senha `telseg`, base `telseg` +- Postgres: porta 5432 exposta localmente (opcional) + +## Parar os serviços +- `docker compose down` para parar +- `docker compose down -v` se também quiser descartar os volumes do Postgres (dados serão perdidos)