NervesHubLink configuration reference

Every NervesHubLink config key in one place: connection, authentication, updates, downloads, extensions, and testing.

Written By Josh Kalderimis

Last updated About 2 months ago

A reference for the options under config :nerves_hub_link. For task-oriented guidance, see Configure NervesHubLink.

Connection

Key	Purpose
`host`	The device endpoint hostname to connect to.
`connect`	Set `false` to stop the client connecting (useful in dev/test).
`connect_wait_for_network`	Wait for `host` to resolve before connecting (default `true`).
`socket`	Options passed to the websocket layer (e.g. `http_opts` for proxies).
`ssl`	Erlang SSL socket options (certfile, keyfile, cacerts, etc.).

Key	Purpose
`shared_secret`	`[product_key: ..., product_secret: ...]` for shared-secret auth.
`configurator`	Module implementing `NervesHubLink.Configurator` (e.g. `...LocalCertKey`).
`:nerves_key`	NervesKey options: `certificate_pair` (`:primary` / `:aux`), `i2c_bus`.
`:tpm`	TPM options: `probe_name`, `key_path`, `certificate_address`.

Key	Purpose
`remote_iex`	Enable the remote IEx console (default `false`).
`remote_iex_timeout`	Inactivity timeout in seconds (default 300).

Key	Purpose
`client`	Module implementing `NervesHubLink.Client` for update decisions and progress.
`fwup_extra_options`	Extra arguments passed to the `fwup` CLI (list of strings).

Key	Purpose
`:retry_config`	Download retry tuning: `max_disconnects`, `idle_timeout`, `max_timeout`.
`downloader_ssl`	SSL options for the firmware download connection.
`downloader_http_opts`	HTTP options (e.g. proxy) for the downloader.

Key	Purpose
`ca_store`	Module with `ca_certs/0` returning DER-encoded CA certificates.
`ssl: [cacerts: ...]`	Set CA certificates directly for the socket.
`downloader_ssl: [cacerts: ...]`	Set CA certificates for downloads.

Key	Purpose
`health`	Health options: `metric_sets`, `metadata`, `report`, `alarms`.
`geo`	Geo options: `resolver`.

See Device health, metrics & geo for the extension options in detail.