|
| 1 | +# Flowise Extension |
| 2 | + |
| 3 | +Visual LLM workflow builder for Dream Server. |
| 4 | + |
| 5 | +## What It Is |
| 6 | + |
| 7 | +Flowise is a drag-and-drop tool to build LLM workflows: |
| 8 | +- Visual node editor for AI pipelines |
| 9 | +- 100+ pre-built integrations |
| 10 | +- Build chatbots, agents, and automation |
| 11 | +- Export as API endpoints |
| 12 | +- No coding required |
| 13 | + |
| 14 | +## Features |
| 15 | + |
| 16 | +- **Visual builder**: Drag-and-drop node editor |
| 17 | +- **LLM support**: OpenAI, Anthropic, Azure, local models |
| 18 | +- **RAG workflows**: Document loaders, chunkers, vector DBs |
| 19 | +- **Agent building**: Tools, memory, decision-making |
| 20 | +- **Integrations**: Slack, Discord, databases, APIs |
| 21 | +- **API export**: Deploy flows as REST endpoints |
| 22 | +- **Chatflows**: Conversational AI builders |
| 23 | + |
| 24 | +## Configuration |
| 25 | + |
| 26 | +### Environment Variables |
| 27 | + |
| 28 | +| Variable | Description | Default | |
| 29 | +|----------|-------------|---------| |
| 30 | +| `FLOWISE_PORT` | External port | `3002` | |
| 31 | +| `FLOWISE_USERNAME` | Admin username | (none) | |
| 32 | +| `FLOWISE_PASSWORD` | Admin password | (none) | |
| 33 | +| `FLOWISE_SECRETKEY_OVERWRITE` | Encryption key | (auto-generated) | |
| 34 | +| `FLOWISE_DISABLE_TELEMETRY` | Disable analytics | `true` | |
| 35 | + |
| 36 | +### Authentication (Optional) |
| 37 | + |
| 38 | +To require login: |
| 39 | +```bash |
| 40 | +# In your .env |
| 41 | +FLOWISE_USERNAME=admin |
| 42 | +FLOWISE_PASSWORD=your-secure-password |
| 43 | +``` |
| 44 | + |
| 45 | +## Usage |
| 46 | + |
| 47 | +```bash |
| 48 | +# Enable the extension |
| 49 | +dream extensions enable flowise |
| 50 | + |
| 51 | +# Start the service |
| 52 | +docker compose up -d flowise |
| 53 | + |
| 54 | +# Access at http://localhost:3002 |
| 55 | +``` |
| 56 | + |
| 57 | +## Quick Start |
| 58 | + |
| 59 | +1. **Enable**: `dream extensions enable flowise` |
| 60 | +2. **Open**: Visit http://localhost:3002 |
| 61 | +3. **Create Chatflow**: Click "Add New" → "Chatflow" |
| 62 | +4. **Add Nodes**: Drag LLM, memory, and tool nodes |
| 63 | +5. **Connect**: Wire nodes together |
| 64 | +6. **Test**: Click chat button to test |
| 65 | +7. **Deploy**: Export as API or embed |
| 66 | + |
| 67 | +## Example Workflows |
| 68 | + |
| 69 | +### Simple Chatbot |
| 70 | +``` |
| 71 | +Chat Input → OpenAI LLM → Chat Output |
| 72 | +``` |
| 73 | + |
| 74 | +### RAG Document Chat |
| 75 | +``` |
| 76 | +PDF Loader → Text Splitter → Vector Store → Retriever → OpenAI LLM → Output |
| 77 | +``` |
| 78 | + |
| 79 | +### AI Agent |
| 80 | +``` |
| 81 | +Chat Input → Agent → [Web Search, Calculator, Code Exec] → LLM → Output |
| 82 | +``` |
| 83 | + |
| 84 | +## Data Persistence |
| 85 | + |
| 86 | +All flows and data stored in: |
| 87 | +- `./data/flowise/` - Workflows, credentials, logs |
| 88 | + |
| 89 | +## Integration with Dream Server |
| 90 | + |
| 91 | +Connect to Dream Server's LLM: |
| 92 | +1. Add "ChatLocalAI" or "Ollama" node |
| 93 | +2. Set Base URL: `http://llama-server:8080/v1` or `http://ollama:11434` |
| 94 | +3. Use models you've downloaded |
| 95 | + |
| 96 | +## Resources |
| 97 | + |
| 98 | +- [Flowise Documentation](https://docs.flowiseai.com/) |
| 99 | +- [GitHub Repository](https://github.com/FlowiseAI/Flowise) |
| 100 | +- [YouTube Tutorials](https://www.youtube.com/@FlowiseAI) |
0 commit comments