IRIS+™ Guides

General Edge™ Device Installation Guide

22min

Overview

Irisity Edge™ Device is either a compact appliance with pre-loaded IRIS+™ software or a server specced specifically to the customer's needs and installed by the customer with IRIS+ software, that connects ONVIF / RTSP fixed IP cameras from the camera's network to Irisity video analytics solution. Irisity Edge™ Device is a gateway between the site’s video cameras and the IRIS+™ Core servers. Therefore, it must always be connected to IRIS+™ Core from one side and to the video cameras on the other. Irisity Edge™ Device connects to the various video cameras using ONVIF or RTSP protocols, performs initial video analysis, and streams the analysis description metadata to IRIS+™ Core servers.

The steps for installing and configuring Irisity Edge™ Devices are as follows:

  1. Installing the IRIS+™ software depends if you purchased the Irisity Edge™ 10 Device from Irisity or you provided your hardware, based on Irisiy's hardware specification (for the latter click here).
  2. Connect Irisity Edge™ Device to IRIS+™ Core (active account). This step is performed once, as part of the initial on-site installation of Irisity Edge™ Devices, using Irisity Edge's™ Device local settings.
  3. Connect the attached Edge™ Device using ONVIF / RTSP protocol to live video streams. This step can be performed once the Irisity Edge™ Device is connected to the IRIS+™ Core and is comprised of the configuration of each ONVIF / RTSP video stream. This step is performed using the IRIS+™ web portal.

Prerequisites and Design Considerations

Before installing the Irisity Edge™ Device, please review the following prerequisites and design considerations

Required equipment

Please make sure the following equipment is available for your use during the installation of Irisity Edge™ Device

  1. PC/Laptop - preferably with Windows OS connected to the site's network
  2. Irisity Edge™ Device connected to the site's network.

Networking

  1. Networking schemes: Irisity Edge™ Device communicates with IRIS+™ Core servers and with the video sources via ONVIF / RTSP. Irisity Edge™ Device must always be connected, using a dynamic or static IP address, to a single or multi-network segment that enables access to the IRIS+™ Core servers (IRIS+™ Core servers may be deployed in the cloud or on-premise) on one hand and the video source segment on the other hand. Please note that the video sources (cameras) must have a static IP address at all times.
  2. Firewall settings
    • Irisity Edge™ Device to IRIS+™ Core For cloud-based deployments example, the site’s firewall must allow Irisity Edge™ Device to access the following endpoints (outbound traffic)
      • *.irisity.io:443 These are IRIS+™ cloud service addresses, required for the Irisity Edge™ Device to continuously communicate with IRIS+™ Core
      • *.docker.com:443
      • *.docker.io:443 These addresses are required when connecting the Irisity Edge™ Device to your IRIS+ account and when performing Irisity Edge™ Device software upgrades. The Docker address redirects traffic to different IP addresses and third-party DNS names (for example cloudfront.net ). The addresses being used are beyond Irisity's control. See the following related docker forum response: Link It is advised to verify with the site’s network administrator that these requirements are fulfilled, before arriving at the site
    • Irisity Edge™ Device to video sources if there's a firewall between the Irisity Edge™ Device and video sources, ONVIF/RTSP ports should be open. Default ports are:
      • ONVIF: 80 (unencrypted), 443 (encrypted)
      • RTSP: 554
  3. DNS Server Irisity Edge™ Device requires access to a DNS server. In case there is no DNS server in the network, access to external DNS must be enabled (for example, to Google’s DNS 8.8.8.8:53)

Usernames and passwords

Before the installation and configuration of the Irisity Edge™ Device, make sure you have the following credentials

  1. Irisity Edge™ Device local username and password: The local username and password are only used to configure Irisity Edge™ Device local settings. The default local username is: admin and the default local password is: Passw0rd!
  2. IRIS+™ web portal account: To connect Irisity Edge™ Device to a specific IRIS+ account and start adding cameras you will need an active IRIS+ account in the cloud with specific credentials such as a username and password that have been activated or a local deployment of IRIS+™ Core. Note: If you do not have the credentials above(2.), please contact your IRIS+™ account administrator

Irisity Edge™ Device is configured with a default username and a default password. It is strongly advised to change the default local password once the Irisity Edge™ Device is connected to the IRIS+ account. This will prevent unauthorized access to Irisity Edge™ Device local settings. (see instructions in "Irisity Edge™ Device settings" below)

Connecting Irisity Edge™ Device to the Network

Irisity Edge™ Device must be connected to a network that allows constant access to IRIS+™ Core endpoints. If the designated network has a DHCP server or you already set a static IP address to your Edge™ Device, you can immediately connect the Irisity Edge™ Device to the network. Otherwise, you need to set a static IP (See Assigning Static IP Address on Edge™ 10 Device) before connecting it to the network:

  1. Connect your PC/Laptop to the same network as the Irisity Edge™ Device
  2. Open your web browser and type in your Edge™ Device IP
  3. Ensure the Irisity Edge™ Device webpage appears (see image below)
Document image


  1. Select "User Settings" (see image below)
Document image

  1. Type in the default local username and password to access the configuration page (see the image below)
Document image

  1. Verify under the "Endpoints" tab that the configuration points to the proper endpoints, modify if needed, and "Apply" changes (see image below)
Document image


Endpoints

Irisity Edge™ Device is configured with default Endpoints settings as follows

  • SaaS: to access Irisity hosted service
  • Customer-hosted: To access the IRIS+ Core in a customer-hosted deployment (On-Premise)
  • Custom: Manually set for custom deployment with private domain either in the Cloud or On-Premise

To connect the Edge™ Device to Irisity's hosted IRIS+™ Core in the cloud use the following endpoints:

For CM Customers:

  • API URL: https://edge.irisity.io
  • Portal URL: https://portal.irisity.io
  • Auth URL: https://auth.irisity.io

Use default registry should be checked

For Enterprise Customers:

  • API URL: https://edge.irisplus.ai
  • Portal URL: https://portal.irisplus.ai
  • Auth URL: https://auth.irisplus.ai

Use default registry should be checked

To connect the Edge™ Device to IRIS+™ Core On-Premise with Irisity's provided domain use the following endpoints:

  • API URL: https://edge.irisplus.app
  • Portal URL: https://portal.irisplus.app
  • Auth URL: https://auth.irisplus.app

Use default registry should be unchecked - and the endpoint should be changed:

  • DOKER REGISTRY: https://registry.irisplus.app



  • Note: In both deployments, a DNS must be configured to resolve these addresses - For Irisity's hosted deployments you can point the Edge™ Device to a public DNS, Irisity's hosted cloud endpoints are publically published

Adding the Irisity Edge™ Device to the IRIS+™ account

The Irisity Edge™ Device must be connected to a network that allows constant access to the IRIS+™ Core endpoints.

Note: the Irisity Edge™ Device can be added only to a dedicated folder and not to the account root folder. Ensure you have created a folder in your IRIS+ account before you start this process. (see image below)

Document image

  1. Using your web browser, navigate to the Irisity Edge™ Device IP address again. The Irisity Edge™ Device web page is displayed (see image below)
Document image

  1. Use your IRIS+ account username and password to log in and add the Irisity Edge™ Device to the IRIS+ account. Note: The Irisity Edge™ Device includes an automatic connectivity test feature that tests the Irisity Edge™ Device's ability to connect to the required IRIS+™ Core cloud or On-Prem endpoints over the internet or LAN network. If one or more of the required endpoints is inaccessible, the Irisity Edge™ Device webpage will show an error message indicating which endpoints cannot be reached. Please configure the firewall to allow outbound traffic from the Irisity Edge™ Device network to all listed IRIS+™ Core endpoints
  2. Once signed in, a list of available folders is displayed (the IRIS+ account administrator grants access privileges to specific folders). Select the folder to which you want the Irisity Edge™ Device to be added to
  3. Once the folder is selected, the Irisity Edge™ Device will be added to the account
  4. Select Physical Devices → Devices tab to view the list
  5. The Edge™ Device will be upgraded to the latest release version and its icon will be displayed in yellow with the status "pending", this process can take a few minutes depending on the internet connection on site, once the Edge™ Device is fully installed, the Edge™ Device icon is turned green. The Edge™ Device is now ready to add cameras

Adding ONVIF/RTSP video streams

  1. In Irisity's web portal, select "Physical view" then the Edge™ Device you just attached
  2. Click Cameras
  3. Click the Add button to add a camera
Document image


5. Give the Camera a name

6. Select camera type based on the camera you are adding (CCD, Thermal)

7. In the Video stream source field, click the Add button

8. Enter the RTSP/ONVIF camera URL

9. Click Add

10. Click Save

Document image


The camera has been added, and live video should be available

Document image




Irisity Edge™ Device settings

Irisity Edge™ Device is configured with some default parameters.

The following chapters explain how to change them. Make sure Irisity Edge™ Device is connected to the IRIS+ account: log in to the IRIS+ account and make sure Irisity Edge™ Device appears in the list of devices. Using your web browser, navigate to Irisity Edge's™ Device IP address. The Irisity Edge™ Device webpage is displayed. Click on the "User Settings"

Sign in to the Irisity Edge™ Device configuration page using the Edge™ Device local username and password provided in the "Password" section above

Once login is successful, select the relevant tab.

Document image




Change Password

  1. Select the "Change Password" tab
  2. Set a new password and retype it
  3. Click "Apply"
Document image


NTP

The default NTP configuration is set to sync time with the Ubuntu operating system installed on the device.

  1. Mark the Use the following NTP checkbox to select a different NTP server/s.
  2. Add the NTP network address
Document image


Contact Irisity customer support

E-mail: Customer Support: [email protected]



PREVIOUS
IRIS+™ Guides
NEXT
Edge™ 10 Device Installation Guide
Docs powered by Archbee