Nodebit provides a phpMyAdmin-like interface for decentralized storage in Node-RED. Manage IPFS networks, OrbitDB databases, and files through an intuitive web interface while building powerful automation flows.
Nodebit transforms Node-RED into a comprehensive platform for decentralized data management. It combines the visual flow programming of Node-RED with the power of IPFS and OrbitDB, providing both programmatic access and a rich administrative interface.
- 📊 Distributed Dashboard: Comprehensive web UI for browsing networks, databases, and files
- 🗄️ OrbitDB Database Management: Create, query, and manage decentralized databases
- 📁 IPFS File Operations: Upload, download, and manage files across IPFS networks
- 🌐 Multi-Network Support: Connect to multiple IPFS networks simultaneously
- 🔄 Real-time Integration: Live updates and monitoring within Node-RED flows
- ⚙️ Configuration Management: Easy setup and management of decentralized infrastructure
cd ~/.node-red
npm install nodebit- Restart Node-RED to load the Nodebit nodes
- Create a workspace configuration:
- Go to hamburger menu → Configuration nodes
- Add a new "nb-workspace" configuration
- Give it a name like "My Workspace"
- Access the Distributed Dashboard:
- In the workspace configuration, click "Open Workspace Admin"
- Browse networks, databases, and files in the web interface
[inject] → [nb-file] → [debug]
- Configure inject node: Set payload to "Hello, IPFS!"
- Configure nb-file node: Select your workspace, operation: "auto"
- Deploy and test: Click inject to upload your first file to IPFS
| Node | Purpose | Status | Description |
|---|---|---|---|
| nb-workspace | Configuration & Admin | ✅ Working | Central hub with phpMyAdmin-like interface |
| nb-file | IPFS file operations | ✅ Demo | Upload, download, pin/unpin files |
| nb-database | OrbitDB operations | ✅ Demo | Create, query, manage databases |
| nb-encrypt | Encryption services | ✅ Optional | Encrypt/decrypt data in flows |
The Distributed Dashboard provides comprehensive management capabilities with five main tabs:
- IPFS Networks: Connected networks and peer counts
- OrbitDB Databases: Database instances, entry counts, storage usage
- IPFS Files: File management, pin status, storage distribution
- Connected Peers: Live peer connections and status
- Recent Activity: Live feed of operations and changes
- IPFS Network Browser: View all connected networks
- Peer Information: Peer IDs, connection status, capabilities
- Network Statistics: Bandwidth, latency, availability metrics
- Connection Management: Add, remove, configure networks
- OrbitDB Browser: Browse all databases across networks
- Database Types: Documents, key-value, event logs, feeds, counters
- Schema Viewer: Inspect database structures and indexes
- Query Interface: Execute queries and view results
- IPFS File Browser: Navigate files across all networks
- Metadata Viewer: File sizes, types, upload dates, pin status
- Bulk Operations: Pin/unpin multiple files, batch downloads
- Storage Analytics: Usage patterns and optimization suggestions
- Visual Query Designer: Drag-and-drop query construction
- Cross-Database Joins: Query across multiple OrbitDB instances
- Export Capabilities: CSV, JSON, and custom format exports
- Saved Queries: Store and reuse complex queries
Nodebit uses a resource-centric design focused on data management rather than connection complexity:
graph TB
subgraph "Node-RED Palette"
WS[nb-workspace<br/>Configuration Node]
FILE[nb-file<br/>File Operations]
DB[nb-database<br/>Database Operations]
end
subgraph "Distributed Dashboard"
UI[phpMyAdmin-like Web UI]
API[HTTP API Endpoints]
end
subgraph "Decentralized Layer"
IPFS[IPFS Networks]
ORBIT[OrbitDB Databases]
end
WS --> UI
WS --> API
FILE --> WS
DB --> WS
WS --> IPFS
WS --> ORBIT
- Configuration Node Pattern: nb-workspace acts as a shared configuration
- Distributed Dashboard Integration: Web UI embedded in Node-RED
- Resource Abstraction: Work with files and databases, not protocols
- Progressive Disclosure: Simple tasks are simple, complex tasks are possible
- Getting Started Guide - Step-by-step setup and first flows
- Architecture Guide - Technical design and patterns
- Node Reference - Detailed documentation for each node
- Examples - Real-world use cases and patterns
- Contributor Guide - Development status, technical docs, and contribution guidelines
[File Upload] → [nb-encrypt: encrypt] → [nb-file: store] → [Share Link Generator]
[HTTP Request] → [nb-database: query] → [Template] → [HTTP Response]
[Timer] → [nb-database: sync check] → [Notification] → [Slack/Email]
[RSS Feed] → [nb-file: cache content] → [nb-database: index] → [API Response]
- Configuration Management: Full workspace configuration with validation
- Distributed Dashboard: Complete web interface for managing distributed data
- Demo Operations: File upload/download and database operations with mock data
- Node-RED Integration: Proper palette integration and flow composition
- HTTP API: RESTful endpoints for programmatic access
Currently, all operations use mock data to demonstrate functionality:
- File Operations: Generate mock CIDs, simulate uploads/downloads
- Database Operations: In-memory storage, simulated OrbitDB operations
- Network Management: Mock IPFS networks and peer connections
- IPFS Integration: Replace mock operations with real Helia/IPFS calls
- OrbitDB Integration: Connect to actual OrbitDB instances
- Network Discovery: Automatic IPFS node detection and connection
- Advanced Security: DID/ACL system with decentralized identity management
We welcome contributions! The current demo implementation provides a solid foundation for adding real IPFS and OrbitDB functionality.
For developers: See the Development Guide for detailed setup instructions, debugging workflow, and activity logging system.
- IPFS Integration: Replace mock file operations with real Helia calls
- OrbitDB Integration: Implement actual database operations
- Network Discovery: Add automatic IPFS node detection
- Security Features: Implement encryption and access control
- Performance Optimization: Caching, batching, and efficiency improvements
MIT License - see LICENSE for details.
Built on the shoulders of giants:
- IPFS - The InterPlanetary File System
- OrbitDB - Decentralized databases
- Helia - Modern IPFS implementation
- Node-RED - Visual programming for IoT
Ready to explore decentralized data management? Start with the Getting Started Guide!