Find quick answers, keyboard shortcuts, common solutions, and links to all EdgeFlow documentation.
Quick Links
Getting Started
Installation, quick start, and core concepts
Flow Editor
Visual editor, nodes, connections, and deployment
Hardware
Raspberry Pi setup, GPIO, and sensor configuration
Debugging
Debug panel, execution context, and troubleshooting
API Reference
REST API, WebSocket, authentication, and endpoints
Deployment
Docker, systemd, and production setup
Keyboard Shortcuts
General
| Ctrl+S | Save flow |
| Ctrl+D | Deploy changes |
| Ctrl+Z | Undo |
| Ctrl+Y | Redo |
Flow Editor
| Ctrl+A | Select all nodes |
| Delete | Delete selection |
| Ctrl+C | Copy nodes |
| Ctrl+V | Paste nodes |
| Space+Drag | Pan canvas |
| Ctrl+Scroll | Zoom in/out |
| Ctrl+0 | Reset zoom to 100% |
| Ctrl+1 | Fit all nodes in view |
Node Operations
| Double-click canvas | Quick add node |
| Double-click node | Open config dialog |
| Enter | Open selected config |
| Ctrl+Shift+D | Duplicate selection |
Import/Export
| Ctrl+I | Import flow |
| Ctrl+E | Export flow |
| Ctrl+Shift+E | Export selected |
Terminal
| Up/Down | Command history |
| Tab | Auto-complete |
| Ctrl+C | Cancel command |
clear | Clear terminal |
help | Show help |
Common Tasks
Create Your First Flow
- Go to Workflows > + New Flow
- Drag an Inject node to the canvas
- Add a Debug node and connect them
- Click Deploy
Connect a Sensor
- Enable I2C/SPI in Settings > Hardware
- Add a sensor node (e.g., DHT22)
- Configure the GPIO pin
- Connect to a Debug node and deploy
Set Up MQTT
- Go to Settings > MQTT
- Enter broker URL and credentials
- Add MQTT In/Out nodes to your flow
- Subscribe or publish to topics
Debug a Flow
- Add Debug nodes after key steps
- Open the Debug tab in the bottom panel
- Deploy and trigger the flow
- Inspect messages in the panel
Install a Module
- Go to Modules page from sidebar
- Click Install Module
- Enter npm package name or URL
- Click Install and wait
Use the Terminal
- Open the Terminal tab in the bottom panel
- Type commands at the prompt
- Use Tab for auto-completion
- Use Up/Down for command history
Monitor System Resources
- Open the Monitor tab in the bottom panel
- View CPU, memory, disk, and temperature
- Check flow execution metrics
- Review health check status
Deploy with Docker
- Install Docker on your system
- Create a docker-compose.yml
- Run docker compose up -d
- Access EdgeFlow at port 8080
Common Errors & Solutions
| Error | Cause | Solution |
|---|---|---|
| Flow Deploy Failed | Invalid node configuration or missing connections | Check node settings and ensure all required fields are filled |
| Node Execution Error | Runtime exception in node logic | Review Debug panel output and check input data format |
| Connection Refused | Target service unreachable (MQTT, database, API) | Verify host, port, and firewall settings |
| Authentication Failed | Invalid credentials or expired token | Check username/password or regenerate API key |
| Command Timeout | Terminal command exceeded 30s limit | Use nohup or screen for long-running commands |
| Module Load Failed | Incompatible module or insufficient memory | Check system resources and module compatibility |
| GPIO Access Denied | Insufficient permissions for hardware access | Add user to gpio group or enable in Settings > Hardware |
| Database Error | Storage operation failed or disk full | Check disk space and database configuration |
| WebSocket Disconnected | Network interruption or server restart | Refresh the page and check EdgeFlow service status |
| Memory Limit Exceeded | System running low on available memory | Disable unused modules or reduce concurrent flows |
API Quick Reference
| Endpoint | Method | Description |
|---|---|---|
/api/v1/flows | GET | List all flows |
/api/v1/flows | POST | Create a new flow |
/api/v1/nodes | GET | List available node types |
/api/v1/resources/stats | GET | System resource statistics |
/api/v1/system/info | GET | System information |
/api/v1/health | GET | Health check status |
/ws | WS | Real-time WebSocket events |
/ws/terminal | WS | Terminal WebSocket shell |
See the full API documentation for authentication, request/response formats, and all available endpoints.
Documentation Map
Getting Started
Core Features
Node Library
Hardware & Deployment
API Reference
Resources
Getting Support
GitHub Issues
Report bugs and request features
Community
Discord server and discussion forums
FAQ
Frequently asked questions and answers
Contributing
Help improve EdgeFlow with code and docs
Version Information
Current Version v1.0.0
License Apache 2.0
Platform Linux (amd64, arm64, armv7)
Runtime Go 1.21+
See the full changelog for release history and upcoming features.