Installing the gateway software on your local device - Amazon IoT SiteWise
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China.

Installing the gateway software on your local device

This section shows you how to install the gateway software on your gateway device on a local device.

Important

Make sure that your gateway device connects to the internet.

This section shows you how to install the gateway software on your gateway device.

Step 1: Copy the installer to your gateway device

The following procedure uses SSH to connect to your gateway device. You can use a USB flash drive or other tools to transfer the installer file to your gateway device.

Connect to your gateway device using SSH

The following instructions explain how to connect to your gateway device using an SSH client.

Prerequisites

Before you connect to your device, complete the following prerequisites.

  • Get the IP address and user name to connect to your device.

  • Install an SSH client on your local computer as needed.

    Your local computer might have an SSH client installed by default. You can verify this by typing ssh in the command line. If your computer doesn't recognize the command, you can install an SSH client.

    • Recent versions of Windows Server 2019 and Windows 10 - OpenSSH is included as an installable component. For more information, see OpenSSH in Windows.

    • Earlier versions of Windows - Download and install OpenSSH. For more information, see Win32-OpenSSH.

    • Linux and macOS - Download and install OpenSSH. For more information, see https://www.openssh.com.

  1. To connect to your device, run the following command in a terminal window on your computer.

    Note

    Replace username and IP with your user name and IP address.

    ssh username@IP
  2. To transfer the installer file that Amazon IoT SiteWise generated to your gateway device, run the following command.

    Note
    • Replace path-to-saved-installer with the path on your computer that you used to save the installer file and the name of the installer file.

    • Replace IP-address with the IP address of your gateway device.

    • Replace directory-to-receive-installer with the path on your gateway device that you use to receive the installer file.

    scp path-to-saved-installer.sh user-name@IP-address:directory-to-receive-installer

Step 2: Install the gateway software

In the following procedures, run the commands in a terminal window on your gateway device.

  1. Give the installer file the execute permission.

    chmod +x path-to-installer.sh
  2. Run the installer.

    sudo ./path-to-installer.sh

This section shows you how to install the gateway software on your gateway device with Windows Server 2019 or later.

You must have the following prerequisites to install the gateway software.

  • Windows Server 2019 or later

  • Administrator privileges

  • PowerShell version 5.1 or later

  • Gateway installer downloaded to the Windows Server where it will be provisioned

Step 1: Run PowerShell as administrator

Log in with administrator privileges and run PowerShell.

  1. On the Windows server where you want to install Amazon IoT SiteWise Edge Gateway, log in as administrator.

  2. Enter PowerShell in the Windows search bar.

  3. In the search results, open the context (right-click) menu on the Windows PowerShell app. Choose Run as Administrator.

Step 2: Install the gateway software

Run the following commands in a terminal window on your gateway device.

  1. Unblock the gateway installer.

    unblock-file path-to-installer.ps1
  2. Run the Installer.

    path-to-installer.ps1
    Note

    If the script execution is disabled on the system, change the script execution policy to RemoteSigned.

    Set-ExecutionPolicy RemoteSigned