Skip to content

Installing JunctionRelay on Raspberry Pi

This guide walks you through installing JunctionRelay using Docker & Portainer on a Raspberry Pi

Prerequisites

  • Raspberry Pi with Docker installed
  • Portainer installed and running
  • Administrative access to your Portainer interface

Installation Steps

1. Access Portainer

  1. Open your web browser and navigate to your Portainer interface
  2. Default URL: http://YOUR_PI_IP:9443
  3. Log in with your Portainer credentials

2. Navigate to Volumes

  1. From the Portainer dashboard, select your Docker environment
  2. Click on Volumes
  3. Click the Add container button
  4. Create a new volume called JunctionRelay

3. Navigate to Containers

  1. From the Portainer dashboard, select your Docker environment
  2. Click on Containers
  3. Click the Add container button

4. Configure Container Settings

Basic Configuration

  1. Name: junctionrelay
  2. Image: catapultcase/junctionrelay:latest

Network & Ports

  1. Network: Select bridge or host depending on your setup
  2. For bridge mode: Map container port 7180 to host port 7180
  3. For host mode: Container will use host networking directly

Port Mapping (if using bridge mode)

Host Port Container Port Protocol
7180 7180 TCP

Volume Mounts

Configure the following volume mappings:

Host Path Container Path Description
/dev /dev Device access for COM ports
/JunctionRelay /app/data Select the volume you created above for perminant data storage

Advanced Settings

  1. Privileged mode: Depending on your setup you may need to enable this option to allow COM device access

5. Deploy the Container

  1. Review all settings to ensure they're correct
  2. Click Deploy the container
  3. Portainer will pull the Docker image and create the container
  4. Wait for the deployment to complete

6. Verify Installation

  1. Go to the Containers list
  2. Verify that junctionrelay shows a status of running
  3. Check the container logs for any error messages

Post-Installation

Accessing JunctionRelay

  1. Once the container is running, access JunctionRelay via:
  2. Direct URL: http://YOUR_PI_IP:7180
  3. Quick Actions: Click the container name, then click 7180:7180 under Published Ports

Troubleshooting

Common Issues

Container fails to start: - Check container logs in Portainer - Verify all volume paths exist on the host - Ensure privileged mode is enabled if accessing devices

Cannot access WebUI: - Verify port mapping is correct (7180:7180) - Check if port 7180 is available: sudo netstat -tlnp | grep 7180 - Ensure no firewall is blocking the port

Checking Logs

To view container logs: 1. Go to Containers in Portainer 2. Click on the junctionrelay container 3. Click Logs to view output and error messages

Updating JunctionRelay

To update to the latest version:

  1. Go to Containers in Portainer
  2. Select the junctionrelay container
  3. Click Stop to stop the container
  4. Click Remove (data will be preserved in volumes)
  5. Follow the installation steps again to deploy the latest image

Alternatively, you can: 1. Click Duplicate/Edit on the existing container 2. Change the image tag if needed 3. Click Deploy the container with "Replace" option

Managing with Docker Compose (Alternative)

For easier management, you can also create a docker-compose.yml file:

version: '3.8'
services:
  junctionrelay:
    image: catapultcase/junctionrelay:latest
    container_name: junctionrelay
    privileged: true
    ports:
      - "7180:7180"
    volumes:
      - JunctionRelay:/app/data
      - /dev:/dev
    restart: unless-stopped

volumes:
  JunctionRelay:

Then use Portainer's Stacks feature to deploy it.