Manage products

Create and configure products in NervesHub: members, enabling the Health, Geo, Local Shell, and Logging extensions, and product settings.

Written By Josh Kalderimis

Last updated About 2 months ago

A product is a group of devices that run the same application, inside an organization. Devices, firmware, deployment groups, archives, and support scripts all belong to a product.

Naming a product to match your Nerves app (for example my_app) is a convenient convention, but not required.

Create a product

In the web UI, create a product from the organization view. From the CLI:

nh product create
nh product list
nh product update <product_name> <key> <value>
nh product delete <product_name>

Members

Products have their own member list, so you can grant access to a specific product without giving access to the whole organization. Roles are the same view / manage / admin hierarchy described in Manage organizations & users.

nh product user list <product_name>
nh product user add <product_name> <username> <role>
nh product user update <product_name> <username> <role>
nh product user remove <product_name> <username>

Extensions

Extensions are optional device features that run over the websocket. They're enabled per product (and per device) in the product's settings:

Extension

What it enables

Health

Device metrics, alarms, and metadata reporting.

Geo

Device geo-location.

Local Shell

An interactive system shell in the web UI.

Logging

Device log capture (requires the ClickHouse-backed logging).

Enabling an extension here lets devices in the product use it. The device also needs the matching NervesHubLink configuration. See Device health, metrics & geo and Remote console & local shell.

Product settings

Product settings also cover things like delta firmware updates and other product-wide behavior. Adjust them under the product's Settings page.

Related