Install¶
Artekis is installed in eight steps. Only one order matters: the module (step 1) must be installed before the views pack and the playbooks that call it (steps 6 and 7). Every other step that is missing or out of order leaves Artekis idle or warning, with the reason on its Status page, never failing to load. The Status page (Services → Artekis → Status in the gateway web interface) shows these eight steps as a setup checklist judged from the gateway's real state: each step done, missing with what to do, or optional. Work down the checklist until every step is green.
| Step | What | If missing or out of order |
|---|---|---|
| 1 | The module. Install Artekis.modl (Config → Modules → Install or Upgrade a Module), accept the certificate and the license agreement, and let the gateway load it. A scripted (headless) install instead places the file under the gateway's module folder and registers it in modules.json with the signing certificate's fingerprint and the agreement's licenseAgreementHash (the CRC32 of the module's license.html entry: 4274987724 for 1.0.1, 1.2.0, 1.2.1, 1.2.2, 1.2.3, 1.2.4, 1.2.5, 1.3.0 and 1.4.0 (52611452 for 1.0.0), recomputed per release); without that hash the gateway waits at /welcome for the agreement to be accepted. |
nothing else works: the views and playbooks have nothing to call: the one hard dependency |
| 2 | Gateway prerequisites. A database connection to the database that will hold the Artekis tables; a Secret Provider holding the model API key; an email profile if you want the digest. | no connection: idle; no secret: every run ends FAILED(credential); no email profile: the email output is off and the run says so |
| 3 | Database tables. Your DBA applies the vendor's DDL (Appendix A) in the default schema of the database the gateway connection (step 2) points at. The exact script for the connection is also served by the running module at GET /data/artekis/ddl and linked from Status. |
the module idles; Status names the missing tables or the version mismatch and links the script |
| 4 | License key, or the trial. Activate the Artekis key under Platform → Licensing, or run on the platform trial while evaluating. | when the trial expires, runs stop; stored findings stay readable (section 5) |
| 5 | Artekis gateway configuration. On the Artekis pages (Services → Artekis): Settings: name the database connection; Providers: add a provider with its secret and role models; Policy: name the active provider, the tag providers Artekis may read, and the security levels; then at least one context model (section 7). | no provider: runs are SKIPPED; no context model: a playbook's collections are skipped and Status warns |
| 6 | Views pack. From the Status page's Views pack card, install the pack into the Perspective project that should show the findings (section 10). | before step 1: the views' bindings error until the module exists |
| 7 | Playbooks. Enable or create at least one playbook in a project (the views pack ships disabled examples; the Playbooks admin view edits them). | Status counts refused playbooks and names the reason |
| 8 | Event Streams (optional) for Incident triggers: an Event Stream you own in the Incident playbook's project, fed by the alarms' pipeline (section 8.3; Status step 8 shows the exact text). | without one, Incident runs only from a script |
After the checklist is green, run a playbook once from the Test run page (Services → Artekis → Test run) with Show prompt: it gathers the evidence and shows exactly what the model would see, free, with nothing leaving the gateway: and then Run with the model, which makes the real call and shows the findings it would store without storing or sending anything. A live run follows from the playbook's trigger.