Developer Guide¶
Welcome to the JunctionRelay Developer Guide. This section provides deep technical documentation for those contributing to, extending, or integrating with the JunctionRelay platform. It covers architectural details, deployment, security, and more.
🧠 Server Architecture¶
An in-depth look at the backend design:
- Service manager, stream pipeline, and database interactions
- WebSocket and HTTP endpoints
- Local and cloud hybrid architecture
📲 ESP32 Architecture¶
Explore the embedded firmware that runs on supported ESP32 devices:
- Modular structure for screens, sensors, and communication
- OTA update handling
- Integration with the JunctionRelay server
📦 Payload Architecture¶
Understand the binary and JSON-based payload format that JunctionRelay uses for communication between server and devices.
- Rendering logic
- Layout definitions
- Compression strategies
🔐 Security Architecture¶
Review the platform’s approach to authentication, encryption, and secure communication:
- API key and token validation
- Cloud auth via Clerk
- Local access controls
🔔 Notifications¶
Add or extend notification support within JunctionRelay:
- Email, push, or WebSocket-triggered alerts
- Integration points for mobile or external services
🚀 Deployment¶
Guidance for deploying JunctionRelay in different environments:
- Docker-based deployment
- Production considerations
- Environment configuration
Need end-user help? See the User Guide.