---
title: General Edge™ Device Installation Guide
slug: iris-plus-documentation/general-edgetm-device-installation-guide
docTags: 
createdAt: 2022-11-30T09:05:30.000Z
---

# 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](https://docs.irisity.com/iris-plus-cm-documentation/edgetm-ci-server-installation-guide)).
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.&#x20;

### Networking

1. Networking schemes:&#x20;
   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 the 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     &#x20;endpoints (outbound traffic)
     - \*.irisity.io:443/\*.irisplus.ai:443 (CM/Enterprise)
       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 in the cloud.&#x20;

       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](https://forums.docker.com/t/docker-registry-public-ip-addresses/10013)

       It is advised to verify with the site’s network administrator that these requirements are fulfilled, before arriving at the site
   - In addition to the setting up the firewall settings, these addresses should be whitelisted:
     - download.docker.com
       github.com
       security.ubuntu.com
       archive.ubuntu.com
       githubusercontent.com
       auth.docker.io
       registry-1.docker.io
       production.cloudflare.docker.com
       edge.irisplus.ai (or edge.irisity.io)
       portal.irisplus.ai (or portal.irisity.io)
       auth.irisplus.ai (or auth.irisplus.io)

   - 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:&#x20;
     - 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   &#x20;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:&#x20;
   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.&#x20;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](https://docs.irisity.com/iris-plus-documentation/edgetm-10-device-installation-guide)) before connecting it to the network:&#x20;

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&#x20;
3. Ensure the Irisity Edge™ Device webpage appears (see image below)

::Image[]{src="https://api.archbee.com/api/optimize/JzHznijrWxPLJLDUaV5A1/xSZQjyRKO6OKCJR5gaaal_screenshot-2024-06-26-at-94811.png" size="56" width="762" height="1023" position="center" darkWidth="762" darkHeight="1023" showCaption="false"}



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

::Image[]{src="https://api.archbee.com/api/optimize/JzHznijrWxPLJLDUaV5A1/37ulATxFQ91i0g-mzy2nY_screenshot-2024-06-26-at-94811.png" size="56" width="762" height="1023" position="center" darkWidth="762" darkHeight="1023" showCaption="false"}

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

::Image[]{src="https://api.archbee.com/api/optimize/JzHznijrWxPLJLDUaV5A1/8vKZCnnS0Xd8zmwZxIllQ_screenshot-2024-07-10-at-135258.png" size="56" width="2310" height="960" position="center" darkWidth="2310" darkHeight="960" showCaption="false"}

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

::Image[]{src="https://api.archbee.com/api/optimize/JzHznijrWxPLJLDUaV5A1/2ycTNIqoawwYwdqG3bd1k_screenshot-2024-07-10-at-135541.png" size="56" width="541" height="357" position="center" darkWidth="541" darkHeight="357" showCaption="false"}

### 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:&#x20;

**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:&#x20;

- 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:

- DOCKER 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&#x20;**

# 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&#x20;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)

::Image[]{src="https://api.archbee.com/api/optimize/JzHznijrWxPLJLDUaV5A1/LjZBHwz1_EQ5i8tCU1rGF_screenshot-2024-06-26-at-112358.png" size="52" width="483" height="285" position="center" darkWidth="483" darkHeight="285" showCaption="false"}

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


::Image[]{src="https://api.archbee.com/api/optimize/JzHznijrWxPLJLDUaV5A1/a5k0XJguwxCGB2A6i87gL_screenshot-2024-06-26-at-112711.png" size="54" width="466" height="1032" position="center" darkWidth="466" darkHeight="1032" showCaption="false"}

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   &#x20;privileges to specific folders). Select the folder to which you want the Irisity Edge™ Device to be   &#x20;added to

3. &#x20;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   &#x20;add cameras

# Adding ONVIF/RTSP video streams

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

::Image[]{src="https://api.archbee.com/api/optimize/JzHznijrWxPLJLDUaV5A1/btr9JNl2jglYqiyCjRTRK_screenshot-2024-06-26-at-144515.png" size="56" width="593" height="391" position="center" darkWidth="593" darkHeight="391" showCaption="false"}

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&#x20;

9\. Click Add

10\. Click Save



::Image[]{src="https://api.archbee.com/api/optimize/JzHznijrWxPLJLDUaV5A1/SXa5jVw_M22zGX333bqfK_screenshot-2024-06-26-at-144646.png" size="62" width="897" height="920" position="center" darkWidth="897" darkHeight="920" showCaption="false"}

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

::Image[]{src="https://api.archbee.com/api/optimize/JzHznijrWxPLJLDUaV5A1/CRDew3mwse2pIs8oAqfuj_screenshot-2024-07-11-at-94421.png" size="60" width="1024" height="648" position="center" darkWidth="1024" darkHeight="648" showCaption="false"}





# Irisity Edge™ Device settings

Irisity Edge™ Device is configured with some default parameters.&#x20;

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"&#x20;

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.

::Image[]{src="https://api.archbee.com/api/optimize/JzHznijrWxPLJLDUaV5A1/YIYKqJsVhGp4v_3zG4GMe_screenshot-2024-06-26-at-94811.png" size="56" width="762" height="1023" position="center" darkWidth="762" darkHeight="1023" showCaption="false"}



### Change Password

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

::Image[]{src="https://api.archbee.com/api/optimize/JzHznijrWxPLJLDUaV5A1/kLRhyuqRKPGGzfWoYBW48_screenshot-2024-06-26-at-131057.png" size="68" width="691" height="279" position="center" darkWidth="691" darkHeight="279" showCaption="false"}

### NTP

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

1. Mark th&#x65;**&#x20;Use the following NTP&#x20;**&#x63;heckbox to select a different NTP server/s.
2. Add the NTP network address

::Image[]{src="https://api.archbee.com/api/optimize/JzHznijrWxPLJLDUaV5A1/gf0RV2-OOq-VPONOQpvsp_screenshot-2024-06-26-at-131115.png" size="66" width="742" height="473" position="center" darkWidth="742" darkHeight="473" showCaption="false"}



# Contact Irisity customer support

E-mail:&#x20;
Customer Support: [technicalsupport@irisity.com](mailto\:technicalsupport@irisity.com)



