From fdcf3e9ed90aee5ea8cad3f33e414c7c1e08c29b Mon Sep 17 00:00:00 2001
From: Matheus <matheus.guedes.mg.m@gmail.com>
Date: Fri, 17 Oct 2025 12:42:29 -0300
Subject: chore:documentação sobre o docker
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 .env.example                |  6 ++++++
 README.md                   | 29 +++++++++++++++++++++++++++++
 mosquitto-config/.gitignore |  1 +
 3 files changed, 36 insertions(+)
 create mode 100644 .env.example

diff --git a/.env.example b/.env.example
new file mode 100644
index 0000000..dee33a5
--- /dev/null
+++ b/.env.example
@@ -0,0 +1,6 @@
+# vim:ft=sh 
+
+# Usuário que o cliente MQTT utilizará para logar
+MQTT_CLIENT_USER="changeme"
+# Senha que o cliente MQTT utilizará para logar
+MQTT_CLIENT_PASSWORD="changeme"
diff --git a/README.md b/README.md
index 0779778..de95f99 100644
--- a/README.md
+++ b/README.md
@@ -5,3 +5,32 @@ Objetivo: Monitorar dados de sensor de microcontroladores e exibi-los em dashboa
 
 O plano inicial é esse:
 ![Imagem overview do plano](docs/overview.png)
+
+## Executar o Projeto
+O projeto foi feito para executar em um servidor rodando Debian 13. Por ser um projeto em Docker, ele pode rodar em qualquer Linux e no Windows se você utilizar o WSL, mas as instruções foram testadas no Debian 13.
+
+### Dependências
++ Docker
++ Docker compose
++ Ser capaz de rodar containeres docker com Linux
+
+### Preparação
+Adicione duas contas do mosquitto em um arquivo `m̀osquitto-conf/pass-file` utilizando o utilitári `mosquitto_passwd`, uma para o cliente MQTT e outra para as estações meteorológicas.
+```sh
+# docker run --rm --user 1883:1883 -ti -v "$PWD"/mosquitto-config:/mosquitto/config eclipse-mosquitto mosquitto_passwd -c /mosquitto/config/pass-file <usuario1>
+
+# docker run --rm --user 1883:1883 -ti -v "$PWD"/mosquitto-config:/mosquitto/config eclipse-mosquitto mosquitto_passwd -c /mosquitto/config/pass-file <usuario2>
+. . .
+```
+Perceba que somente a primeira camada de `mosquitto_passwd` tem o argumento `-c`. **Quaisquer outras chamadas não podem conter o argumento `-c`, ele sobreescreve o arquivo.**
+
+Copie o arquivo `.env.example` para `env` e edite seus valores. Os comentários explicam o que cada variável faz.
+```sh
+$ cp .env.example .env
+```
+
+Inicie o projeto com o docker compose
+```sh
+# docker compose up -d
+```
+
diff --git a/mosquitto-config/.gitignore b/mosquitto-config/.gitignore
index b02cae3..074174d 100644
--- a/mosquitto-config/.gitignore
+++ b/mosquitto-config/.gitignore
@@ -1 +1,2 @@
 pass-file
+pass-file.backup.*
-- 
cgit v1.2.3