Before you start
Prerequisites
- Install SyftBox from syftbox.net
- Add the syft-llm-router app using this URL:
https://github.com/OpenMined/syft-llm-router
Installation Guide
The syft-llm-router app provides a dashboard to manage router creation, data indexing, and publication.
Add the syft-llm-router app to your SyftBox installation
Bring your data to the network
1
Create router
Set up your router service type and configuration.
- Click New router in the dashboard
- Choose your router mode:
🔋 Default Router
Ready-to-use with TinyLlama and local vector database
⚙️ Custom Router
Bring your own infrastructure and integration code
- Select service type:
- Search: Returns relevant quotes from your data
- Chat: Local LLM that can speak to your data
- Router is created as a draft (not yet public)
Choose between Default or Custom router configuration
2
Add data
Upload and index your documents for search and chat functionality.
- Start your draft router
- Navigate to the router URL from logs
- Upload and index your data
Supported formats:
- .md, .pdf, .json, .yaml, .txt
- Need custom formats? Contact OpenMined
- For dynamic data: Create Syft apps for WordPress, Ghost, Slack, Notion, REST APIs
Upload and index your documents for search and chat
3
Publish
Make your router discoverable to others on the network.
- Click Publish in router dashboard
- Add metadata (title, description, tags)
- Set pricing (can start free)
- Confirm publication
Add metadata and pricing to make your router discoverable
4
Try it out
Test your router with the built-in chat interface.
- Try it out in the chat interface
- Monitor usage metrics in the dashboard
- Your router is now live and discoverable!
Test your router with the built-in chat interface