@igoruehara/canvas-flow 0.1.4 → 0.1.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +79 -11
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -74,6 +74,8 @@ No Windows:
|
|
|
74
74
|
C:\Users\<usuario>\.canvas-flow\config.json
|
|
75
75
|
```
|
|
76
76
|
|
|
77
|
+
Esse arquivo guarda porta, MongoDB, tokens e provedores. Nao publique `config.json`: ele contem secrets gerados e chaves de API.
|
|
78
|
+
|
|
77
79
|
Abrir a config:
|
|
78
80
|
|
|
79
81
|
```bash
|
|
@@ -86,36 +88,102 @@ Ver o caminho da config:
|
|
|
86
88
|
npx @igoruehara/canvas-flow@latest config
|
|
87
89
|
```
|
|
88
90
|
|
|
89
|
-
|
|
91
|
+
Ver a config no terminal:
|
|
92
|
+
|
|
93
|
+
```bash
|
|
94
|
+
npx @igoruehara/canvas-flow@latest config --show
|
|
95
|
+
```
|
|
96
|
+
|
|
97
|
+
Tambem da para configurar ao iniciar. Esses parametros valem para aquela execucao:
|
|
98
|
+
|
|
99
|
+
```bash
|
|
100
|
+
npx @igoruehara/canvas-flow@latest --port 3334 --public-url http://localhost:3334 --open
|
|
101
|
+
npx @igoruehara/canvas-flow@latest --config C:\canvas-flow\config.json --open
|
|
102
|
+
npx @igoruehara/canvas-flow@latest --home C:\canvas-flow-data --open
|
|
103
|
+
```
|
|
104
|
+
|
|
105
|
+
### Campos principais
|
|
106
|
+
|
|
107
|
+
`server`: controla porta, URL publica, Swagger, CORS e abertura do navegador.
|
|
108
|
+
|
|
109
|
+
```json
|
|
110
|
+
{
|
|
111
|
+
"server": {
|
|
112
|
+
"port": 3333,
|
|
113
|
+
"publicUrl": "http://localhost:3333",
|
|
114
|
+
"openBrowser": false
|
|
115
|
+
}
|
|
116
|
+
}
|
|
117
|
+
```
|
|
118
|
+
|
|
119
|
+
`database`: obrigatorio. Use Mongo local, Mongo do Docker ou MongoDB Atlas.
|
|
120
|
+
|
|
121
|
+
```json
|
|
122
|
+
{
|
|
123
|
+
"database": {
|
|
124
|
+
"mongoUrl": "mongodb://127.0.0.1:27017/canvas_flow"
|
|
125
|
+
}
|
|
126
|
+
}
|
|
127
|
+
```
|
|
128
|
+
|
|
129
|
+
`auth`: gerado automaticamente. Mantenha `apiToken`, `jwtSecret` e `mediaProxySecret` privados. `login` e opcional.
|
|
130
|
+
|
|
131
|
+
```json
|
|
132
|
+
{
|
|
133
|
+
"auth": {
|
|
134
|
+
"login": false,
|
|
135
|
+
"apiToken": "generated-by-canvas-flow-init",
|
|
136
|
+
"jwtSecret": "generated-by-canvas-flow-init"
|
|
137
|
+
}
|
|
138
|
+
}
|
|
139
|
+
```
|
|
140
|
+
|
|
141
|
+
`providers`: opcional. Preencha somente os provedores que vai usar. Sem chave de LLM, fluxos que chamam IA/LLM nao vao executar geracao.
|
|
90
142
|
|
|
91
143
|
```json
|
|
92
144
|
{
|
|
93
145
|
"providers": {
|
|
94
146
|
"openai": {
|
|
95
|
-
"apiKey": "sk-..."
|
|
147
|
+
"apiKey": "sk-...",
|
|
148
|
+
"chatModel": "gpt-4o"
|
|
149
|
+
},
|
|
150
|
+
"claude": {
|
|
151
|
+
"apiKey": "",
|
|
152
|
+
"chatModel": "claude-sonnet-4-6"
|
|
153
|
+
},
|
|
154
|
+
"gemini": {
|
|
155
|
+
"apiKey": "",
|
|
156
|
+
"chatModel": "gemini-3.5-flash"
|
|
96
157
|
}
|
|
97
158
|
}
|
|
98
159
|
}
|
|
99
160
|
```
|
|
100
161
|
|
|
101
|
-
|
|
162
|
+
Tambem e possivel configurar provedores pela propria aplicacao depois que ela estiver rodando. Nesse caso, a configuracao fica salva no MongoDB.
|
|
163
|
+
|
|
164
|
+
`providers.milvus`: opcional para RAG com Milvus/Zilliz. Milvus local via Docker pode rodar sem token. Milvus remoto normalmente precisa de `token` ou `username/password`.
|
|
102
165
|
|
|
103
166
|
```json
|
|
104
167
|
{
|
|
105
|
-
"
|
|
106
|
-
"
|
|
107
|
-
|
|
168
|
+
"providers": {
|
|
169
|
+
"milvus": {
|
|
170
|
+
"address": "",
|
|
171
|
+
"token": "",
|
|
172
|
+
"collectionName": "canvas_flow_docs"
|
|
173
|
+
}
|
|
108
174
|
}
|
|
109
175
|
}
|
|
110
176
|
```
|
|
111
177
|
|
|
112
|
-
|
|
178
|
+
`providers.azureSearch` e `providers.azureBlob`: opcionais para RAG/arquivos usando Azure AI Search e Azure Blob.
|
|
113
179
|
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
180
|
+
`files`: opcional. Por padrao usa armazenamento local em `./tmp/canvas-flow-documents`. Configure S3 apenas se quiser arquivos em bucket.
|
|
181
|
+
|
|
182
|
+
`sqs`: opcional. Ative apenas se quiser filas AWS SQS para transicoes assincronas.
|
|
183
|
+
|
|
184
|
+
`rateLimit`, `httpBatch` e `agentOps`: opcionais. Ajustam limites de API, timeouts de chamadas HTTP em lote e historico/trace operacional.
|
|
117
185
|
|
|
118
|
-
|
|
186
|
+
`runtime` e `aws`: opcionais. Ajustam timezone, execucao de cron, limites do runtime e regiao AWS.
|
|
119
187
|
|
|
120
188
|
## Validar
|
|
121
189
|
|