Install¶

Install Artek-MQTT-Common first or together with Pub and Sub. Ignition resolves the dependency itself, so the order you upload them in does not matter, but Pub and Sub will not start without Common.

Install Common, Pub and Sub from the same release

Pub and Sub need Common from the same release. A mixed install fails at module setup with a clear error instead of half-starting. Pub's and Sub's status routes report the Common version actually installed (commonVersion), so a mismatch is easy to spot.

Before you start¶

Ignition 8.3.4 or later.
The .modl files for the modules you need, all from the same release (see Which modules you need).
The modules are signed with the Artek, LLC certificate. Its SHA-1 fingerprint is:
```
99e472815b3417abab93e1c744c76699c73375d2
```
Compare it with the fingerprint the gateway shows when it asks you to accept the certificate.

Install from the gateway web interface¶

Open the gateway web interface and go to Config → Modules.
Choose Install or Upgrade a Module and upload Artek-MQTT-Common.modl.
Check the certificate fingerprint against the value above and accept the certificate.
Read and accept the license agreement.
Repeat for Artek-MQTT-Pub.modl and/or Artek-MQTT-Sub.modl.
Verify the install.

Install from disk (scripted)¶

For a headless or scripted install, place each .modl on the gateway and register it in the gateway's data/modules.json. Each entry needs:

Key	Value
`filename`	Full path to the `.modl` file.
`onStartup`	`"enabled"`
`certFingerprint`	The signing certificate fingerprint: `99e472815b3417abab93e1c744c76699c73375d2`
`licenseAgreementHash`	The CRC32 of the `license.html` entry inside that `.modl`, as a number.

For release 1.1.1 the licenseAgreementHash values are:

Module id	`licenseAgreementHash` (1.1.1)
`com.artek.mqtt.common`	`3928685938`
`com.artek.mqtt.pub`	`2861451525`
`com.artek.mqtt.sub`	`683463532`

The hash changes whenever the license text changes, so recompute it from each new .modl rather than reusing an old value. Without a correct hash the gateway waits for the license agreement to be accepted in a browser. Restart the gateway after editing modules.json, then verify the install.

Upgrade¶

Upgrade all installed modules to the same release at the same time, using either method above.

Upload all three together. Upgrading only one module leaves a mixed install, which Pub and Sub refuse at startup.
If the signing certificate changes, the gateway asks you to accept the new certificate once on install. If you register the modules in modules.json, update each module's certFingerprint to match the new certificate, or the module is quarantined on restart instead of loading.
Stored passwords are migrated automatically. Connection profiles saved by earlier versions are migrated once at the first startup after the upgrade, so their passwords and TLS key material are stored encrypted. If every broker URL in a profile carried the same user:pass@ credentials, those are moved into the profile's username and password fields.
Check the Release notes for anything specific to the release you are moving to.

Verify the install¶

Each module serves a read-only status route that needs no login:

GET /data/artek-mqtt-common/status
GET /data/artek-mqtt-pub/status
GET /data/artek-mqtt-sub/status

Open them in a browser on the gateway's address. A JSON response means the module is running. On Pub and Sub, confirm that commonVersion matches the Common release you installed.

Then open Artek MQTT → Connections in the gateway web interface, create a connection profile (see Connections) and check that its status card shows it connected.