JunctionRelay Server - User Guide¶
Welcome to the JunctionRelay User Guide. This section contains all the documentation you need to install, configure, and use JunctionRelay across a wide variety of platforms and environments. Whether you're setting up your first server or configuring advanced payloads and services, this guide will walk you through every step.
📦 Server Installation¶
Learn how to install the JunctionRelay backend server on your preferred platform:
- Unraid — Install via Community Applications.
- Raspberry Pi — Deploy using Docker and Portainer.
- Windows — Run the pre-built binaries with ease.
🔧 ESP32 Installation¶
Get your ESP32 devices connected and running JunctionRelay firmware:
- Flash with ESPTool or Arduino IDE
- Learn about supported displays, I2C peripherals, and connection modes
🔐 Authentication¶
Understand the available authentication modes:
- No authentication
- Local login
- Cloud-based OAuth via Clerk
🧾 Licenses¶
Learn about the different license tiers:
- Free license (default with Cloud login)
- Pro license (supports project development and unlocks extra features)
🗄️ Database¶
Explore how JunctionRelay stores and manages your data:
- Local database options
- Identity and backup/restore support
📟 Devices¶
Manage and view the devices registered with your JunctionRelay instance.
📥 Collectors¶
Configure data collectors to pull sensor, system, or network data into JunctionRelay.
🧩 Services¶
Enable integrations and data forwarding services such as:
- MQTT Broker for pub/sub messaging
- Home Assistant integration
📦 Payloads¶
Understand the structure and purpose of payloads:
- How data is sent from Collectors to Devices
🔀 Junctions¶
Junctions link your data sources to your devices with streaming logic and layouts.
☁️ Cloud¶
Explore cloud-specific features, including cloud login, device sync, and more.
📱 Mobile App¶
Information about the JunctionRelay mobile app and supported functionality.
Need developer docs? See the Developer Guide.