Edge Setup

The edgectl command line tool can be used to install, update, and monitor Edge on your device.

Installing edgectl

APT (Debian Linux)

# echo "deb [trusted=yes] https://apt.fury.io/edgeiq/ /" > /etc/apt/sources.list.d/fury.list
# apt update
# apt install edgeiq-edgectl

or

Download

Architecture

OS

Link

x86_64

Linux

Download

AArch64

Linux

Download

ARMv7

Linux

Download

Usage

The install command will walk you through an interactive installation process:

# edgectl install

If a non-interactive or automated install is required, a bootstrap filepath can be specified using the -b flag:

# edgectl install -b [bootstrap-filepath]

Bootstrap parameters

Key

Type

Description

Required

comapny_id

string

Company identifier

true
(if identifier_filepath is not set)

version

string

Edge version to install

false
(default: latest)

install_dir

string

Installation directory

false
(default: /opt)

platform

string

The device platform [“generic”, “zum_series”, ”netcomm”, ”connected_io”]

false
(default: generic)

init_system

string

The init system (linux only)

false

network_configurer

string

The network configuration/management tool (linux only)
[“none”, “nmcli”, ”netplan”, ”openwrt”]

false
(default: none)

local

bool

Run Edge in local-only mode

false
(default: false)

identifier_filepath

string

Identifier filepath. If this file is located at the given path, it allows you to specify the unique identifier, overriding the local service's default behavior of picking the first network interface's MAC as the UID.

false
(default: /opt/identifier.json)

Example bootstrap file:

{
  "company_id": "companyco",
  "platform": "generic",
  "init_system": "systemd",
  "network_configurer": "none",
  "local": false,
  "install_dir": "/opt",
  "version": "latest",
  "identifier_filepath": ""
}

Example identifier file:

{
  "company_id": "companyco",
  "unique_id": "4429949859829"
}

Did this page help you?