Installing JunctionRelay on Unraid¶
This guide walks you through installing JunctionRelay from Unraid's Community Applications (CA).
Prerequisites¶
- Unraid 6.8.0 or later
- Community Applications plugin installed
- Administrative access to your Unraid server
Installation Steps¶
1. Access Community Applications¶
-
Log into your Unraid web interface
-
Navigate to the Apps tab in the main menu
Note: If you don't see the Apps tab, follow the instructions here
2. Search for JunctionRelay¶
- In the Apps tab, use the search bar at the top
- Type
JunctionRelay
and press Enter - Look for the JunctionRelay application in the search results
3. Install JunctionRelay¶
- Click on the JunctionRelay application card
- Review the application details and description
- Click the Install button
- The Docker container template will open
4. Configure Installation Settings¶
The following settings should auto-populate, but customize as needed
Basic Settings¶
- Name:
JunctionRelay
- Repository:
catapultcase/junctionrelay:latest
- Network Type: Select
host
(recommended) orbridge
depending on your setup
Port Configuration¶
- Host Mapping: Default port is
7180
- change if this port is already in use
Volume Mappings¶
Configure the following path mappings:
Container Path | Host Path | Description |
---|---|---|
/dev |
/dev |
This will allow JunctionRelay to access COM devices on the host. Depending on your setup, you may need to also enable 'Privileged' mode |
/app/data |
/mnt/user/appdata/junctionrelay |
Default path is /mnt/user/appdata/junctionrelay but change as needed |
5. Complete Installation¶
- Review all settings to ensure they're correct
- Click Apply to start the installation
- Unraid will download the Docker image and create the container
- Wait for the installation to complete
Post-Installation¶
Accessing JunctionRelay¶
- Once installation is complete, you can access JunctionRelay via:
- WebUI: Click the JunctionRelay icon in the Docker tab and click
WebUI
- Direct URL:
http://YOUR_UNRAID_IP:7180
(replace with your actual IP)
Troubleshooting¶
Common Issues¶
Container won't start:
- Check the logs for error messages
- Verify port conflicts with other containers
- Ensure volume paths exist and have correct permissions
Can't access WebUI:
- Verify the port mapping is correct
- Check if the port is blocked by firewall
- Ensure the container is running
Updating JunctionRelay¶
To update to the latest version:
- Go to the Docker tab
- Click the JunctionRelay container icon
- Select Update Container
- Follow the prompts to pull the latest image
Uninstalling¶
To remove JunctionRelay:
- Stop the container in the Docker tab
- Click the container icon and select Remove
- Optionally, delete the appdata folder when prompted