profgabrielramos commited on
Commit
72d747f
·
verified ·
1 Parent(s): 26060c4

docs: update README for local-only reindex

Browse files
Files changed (1) hide show
  1. README.md +16 -4
README.md CHANGED
@@ -14,10 +14,10 @@ Bot para Discord com RAG (Retrieval-Augmented Generation) usando documentos jur
14
 
15
  ## Visão Geral
16
 
17
- O projeto combina três partes principais:
18
 
19
  - Bot Discord (`!rag`, `!reindex` e resposta por menção)
20
- - API FastAPI para saúde, logs e reindexação protegida por token
21
  - Pipeline de ingestão que baixa documentos, sanitiza arquivos, cria embeddings e publica artefatos de índice
22
 
23
  ## Funcionalidades
@@ -84,7 +84,7 @@ python main.py
84
  |---|---|---|---|
85
  | `DISCORD_TOKEN` | Sim | - | Token do bot Discord |
86
  | `BOT_PREFIX` | Não | `!` | Prefixo de comandos |
87
- | `REINDEX_API_TOKEN` | Sim | - | Token Bearer para `POST /reindex` |
88
  | `HF_TOKEN` | Sim | - | Token para Hugging Face Hub/Inference |
89
  | `HF_TEXT_MODEL` | Não | `microsoft/Phi-3.5-mini-instruct` | Modelo de geração de texto |
90
  | `HF_INFERENCE_URL` | Não | construído a partir de `HF_TEXT_MODEL` | URL da Inference API |
@@ -112,7 +112,8 @@ python main.py
112
  - `GET /health` -> `ok`
113
  - `GET /logs` -> últimos logs da ingestão
114
  - `POST /reindex` -> dispara ingestão
115
- - Header obrigatório: `Authorization: Bearer <REINDEX_API_TOKEN>`
 
116
 
117
  ## Docker
118
 
@@ -120,6 +121,17 @@ Build e run local:
120
 
121
  ```bash
122
  docker build -t botspace .
 
 
 
 
 
 
 
 
 
 
 
123
  docker run --rm -p 7860:7860 \
124
  -e DISCORD_TOKEN="$DISCORD_TOKEN" \
125
  -e REINDEX_API_TOKEN="$REINDEX_API_TOKEN" \
 
14
 
15
  ## Visão Geral
16
 
17
+ O projeto combina tres partes principais:
18
 
19
  - Bot Discord (`!rag`, `!reindex` e resposta por menção)
20
+ - API FastAPI para saude, logs e reindexacao
21
  - Pipeline de ingestão que baixa documentos, sanitiza arquivos, cria embeddings e publica artefatos de índice
22
 
23
  ## Funcionalidades
 
84
  |---|---|---|---|
85
  | `DISCORD_TOKEN` | Sim | - | Token do bot Discord |
86
  | `BOT_PREFIX` | Não | `!` | Prefixo de comandos |
87
+ | `REINDEX_API_TOKEN` | Nao | - | Se definido, exige Bearer token no `POST /reindex`; se ausente, aceita apenas localhost |
88
  | `HF_TOKEN` | Sim | - | Token para Hugging Face Hub/Inference |
89
  | `HF_TEXT_MODEL` | Não | `microsoft/Phi-3.5-mini-instruct` | Modelo de geração de texto |
90
  | `HF_INFERENCE_URL` | Não | construído a partir de `HF_TEXT_MODEL` | URL da Inference API |
 
112
  - `GET /health` -> `ok`
113
  - `GET /logs` -> últimos logs da ingestão
114
  - `POST /reindex` -> dispara ingestão
115
+ - Se `REINDEX_API_TOKEN` estiver definido: requer `Authorization: Bearer <REINDEX_API_TOKEN>`
116
+ - Se `REINDEX_API_TOKEN` nao estiver definido: apenas chamadas de `127.0.0.1`/`::1` sao aceitas
117
 
118
  ## Docker
119
 
 
121
 
122
  ```bash
123
  docker build -t botspace .
124
+ docker run --rm -p 7860:7860 \
125
+ -e DISCORD_TOKEN="$DISCORD_TOKEN" \
126
+ -e HF_TOKEN="$HF_TOKEN" \
127
+ -e DOCS_REPO_ID="$DOCS_REPO_ID" \
128
+ -e INDEX_REPO_ID="$INDEX_REPO_ID" \
129
+ botspace
130
+ ```
131
+
132
+ Com protecao por token (opcional):
133
+
134
+ ```bash
135
  docker run --rm -p 7860:7860 \
136
  -e DISCORD_TOKEN="$DISCORD_TOKEN" \
137
  -e REINDEX_API_TOKEN="$REINDEX_API_TOKEN" \