Docs

From first sign-in to a fully documented site.

The short version of the product guide: the order to do things in, and what each step gives you. The full in-app guide is under Academy once you are signed in.

See all features

1. Create your organisation

Every SPARK account belongs to an organisation: an MSP with many clients, or a single company (Solo) looking after its own sites.

  1. 1Choose Start free on the website, enter your work email and a password, then confirm the email we send you.
  2. 2Name your organisation and choose MSP or Solo. Nothing is charged at this step.
  3. 3Turn on two-factor authentication from Settings → Security. Every additional team member is free.

2. Enrol a site collector

The collector is the SPARK Box, a pre-programmed box that documents the site it is plugged into, or your own hardware running our image. Its discovery is read-only and it only ever connects outbound.

  1. 1Add the client and site in Clients, then open the site and choose Add collector to get a one-time site code.
  2. 2Boot the collector on the site network and enter the site code. It enrols, downloads its configuration and starts its first sweep.
  3. 3Set the subnets to scan and the scan rate. Use a low rate for VLANs with OT, AV or building-control equipment.
  4. 4Watch the site dashboard: the health signal turns green when the first heartbeat and sweep arrive.

3. Connect cloud controllers

Cloud controllers add identity, status and link data the collector cannot see on its own.

  1. 1Go to Settings → Integrations and add Meraki (API key) or UniFi (console URL or Site Manager API key). Credentials are encrypted and only used server-side.
  2. 2Map each controller network to the matching site. Devices seen by both the collector and the controller are correlated by MAC address and marked confirmed.
  3. 3Fortinet, Catalyst, Peplink, Teltonika, Crestron and Lutron connections can be configured now; their syncs light up as each one goes live.

4. Topology and documentation

The Topology page shows the live map of a site. Documentation is the spreadsheet-style record behind it.

  1. 1Open a site → Topology. The auto map is built from real link data; hover a device for its status, ports and sources.
  2. 2Choose Save as diagram to turn the live view into an editable diagram, then add pages, cabling and labels for the client-facing version.
  3. 3In Documentation, edit names, roles, owners and notes inline. Discovery keeps IPs, MACs and vendors current.
  4. 4Export the documentation and diagrams to PDF for client packs and audits.

5. Credentials and remote access

Credentials live next to the device they belong to, and remote sessions start from the same record.

  1. 1Add credentials in Password Vault and link them to devices. Entries are encrypted with AES-256 and every view is logged.
  2. 2Enable the site tunnel from the site page. It is a per-site WireGuard tunnel you can switch on and off as needed.
  3. 3From a device record, open SSH, RDP, HTTPS or Telnet through the tunnel, or trigger a reboot through the cloud integration where supported.

6. Tickets, maintenance and time

The service modules attach work to the client and device it concerns, so evidence is captured as you go.

  1. 1Raise tickets from alerts, devices or the client page. Inbound email can be routed to tickets from Settings.
  2. 2Log maintenance reports and on-site visits with photos and signatures; clients can view approved reports in the portal.
  3. 3Track time with the live timer. Approved entries flow to Accounts for billing and to SLA contracts for allowance tracking.

7. Administration

Organisation-wide settings, billing and the client portal live under Settings.

  1. 1Invite team members from Users and assign roles. MSP includes 3 users and Solo 1; each extra user is €19 a month.
  2. 2Manage client subscriptions and AI credit from Settings → Billing.
  3. 3MSP accounts can brand the client portal and add a custom domain so clients see their documentation under your name.
  4. 4Use Ctrl/Cmd + K anywhere to search clients, devices, tickets and documentation.

Stuck at any step? Email support@sparkdock.io or use the assistant on the website. The Academy module inside the app has the long-form version with screenshots.