Guides

Preface

This document will take you through the XYTE Connect+ Edge installation process using Docker Desktop for Windows.

This is the recommended method to get started with XYTE Connect+ Edge on Windows based systems. Please contact your XYTE Representative with any issues or questions.

References

Docker Documentation:

Instructions

Enable Telnet within Windows

  1. Open Control Panel
  2. Select ‘Programs’
  1. Select the ‘Turn Windows Programs On and Off’ (Requires Administrator)
  1. Select ‘Telnet Client’ from the list

Install Docker Desktop

  1. Download Docker Desktop Installer

    1. Requires Restart (complete previous Telnet step before restarting)
  2. Upon Restart:

    1. Open Docker Desktop Application
    2. A new Command Prompt window should automatically open prompting installation of WSL
      1. Press any key in the Command Prompt window to continue
    3. Login to Docker not necessary, ‘skip’ may be selected on launch / setup
    4. Restart Docker within Docker Desktop window
    5. In Docker Settings -> General -> Enable “Launch Docker Desktop on Login”

Install Connect+ Edge

  1. Open PowerShell
  2. Execute the following commands:
Invoke-WebRequest -Uri "https://raw.githubusercontent.com/xyte-io/edge/refs/heads/windows-main/edge_runner_script.ps1" -OutFile "edge_runner_script.ps1"

powershell -ExecutionPolicy Bypass .\edge_runner_script.ps1
  1. Response return should appear as
Edge Id: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
  1. Associate the Edge ID within the XYTE Portal

Configure Docker to Load on Startup

  1. Open Task Scheduler
  2. Select "Create Task..."
  1. General Tab:
    1. Name = "Start Docker"
    2. Run whether user is logged in or not
    3. Run with Highest Privileges
    4. Configure for Windows 10

  1. Triggers Tab:
    1. Begin the task = "At startup"
    2. Advanced Settings = "Enabled"
  1. Actions Tab:
    1. Action = "Start a program"
    2. Program/script = "Docker Desktop.exe"
      1. You will need you use Browse to find where the Docker folder was installed, the default will be "C:\Program Files\Docker\Docker Desktop.exe"

  1. Conditions
    1. If running on a laptop, be considerate of the AC Power and Battery options to your needs