Configuration

The module reads its defaults from its antelope.config.ts entry. The Settings page overrides some of them at runtime, for the whole deployment, without a restart.

"dms-marketing": {
  source: { type: "package", package: "@antelopejs/dms-marketing", version: "^0.6.0" },
  config: {
    geoipDatabasePath: "/var/lib/geoip/GeoLite2-Country.mmdb",
  },
},

Module options

Tracking the dashboard itself

A demo, a playground or a back office that wants the usage of its own admin in Marketing turns on dashboardTracking. No frontend code is written: the module loads its tracker on every dashboard page through its own frontend layer.

"dms-marketing": {
  source: { type: "package", package: "@antelopejs/dms-marketing", version: "^0.6.0" },
  config: {
    dashboardTracking: {
      enabled: true,
      websiteName: "Dashboard", // optional
      excludePaths: ["/settings/**"], // optional
    },
  },
},

What it does:

• One website per workspace, created on first use. The first time someone signed in opens the dashboard, the module creates a website for their workspace (tenant), named websiteName, with the host the dashboard answered on as its domain. Its id derives from the tenant, so every instance and every tab agrees on it and a second visit creates nothing. A host the dashboard is later opened from (a staging name next to localhost) joins its extra hosts, up to the 20-host cap. It shows up on the Websites page like any other: rename it, pause it (Collect data) or delete it — a deleted one comes back on the next dashboard visit while the option is on.
• Signed-in pages only. The tracker loads once someone is signed in and pauses as soon as they sign out; a workspace switch moves it to the new workspace's website without a reload, so no page of one workspace reaches another's. The sign-in pages (/auth/**, the account switcher included) are never counted, whatever excludePaths says. During an identity transition, new events are dropped until the tag is retargeted; the old queue is still sent under its original website.
• SPA navigations count. The dashboard navigates without reloading; the tracker counts each page it lands on, like on any single-page site (Tracker).
• The module's promises hold. First-party (the tracker and its beacons stay on the dashboard's own origin), cookieless, no IP or user agent stored, Do Not Track and Global Privacy Control honoured. Pages are not tied to the account browsing them by the collector: it does not use the authenticated account, and visitors use the same monthly rotated hashes as on any site. Page snapshots default to off on this website, but an owner can enable them through the ordinary website settings. This is not a server-enforced prohibition: a capture of an admin page would store the records it shows, so leave snapshots off.

The dashboard's frontend reads the option when it starts: after turning it on or off, restart ajs dms dev or rebuild the frontend (ajs dms build). The module-wide switch (trackerEnabled, Settings) pauses it like every other site.

Settings from other modules

Runtime settings

The Settings page edits the collection switch, the three retentions and the heatmap sampling for every tenant and website. A field left empty follows the config default above. Per-site options (page snapshots, text masking, extra hosts, collect data) live in each website's drawer on the Websites page.