Documentation

Sharing status and results

Dokima always generates a local report in ./dokima-report/ with live review status and completed findings. Reviews and publishing continue when you select Run in Background; run dokima again to reconnect.

Choose where your team reads reports

On first launch, choose how to handle reports:

  • Publish privately to Dokima.net (Recommended): Dokima shows a browser link where you sign in, select your organisation and approve the installation before any upload begins.
  • Local HTML reports only: Keeps status and results in the local ./dokima-report/ folder only.

Both options produce local HTML reports, and no report or review status is uploaded until you approve the installation in your browser. You can change this anytime in Settings under Dokima.net private publishing or by running dokima publishing configure (stop active work before changing settings).

Run Dokima on a dedicated Linux VPS, VM or user account with access to your code and runner. Publish results privately to Dokima.net, or serve the local report on a protected internal company website when running on your own infrastructure. Reviews stay on the Dokima machine; teammates read the reports in their browsers.

Local files or an internal web server

Open dokima-report/index.html directly, or serve the dokima-report/ folder on your own internal web server:

  • Copy or symlink the whole folder, including status.js, publication.js and the generation directories. When copying periodically, copy to a temporary path first and switch your server directory or symlink once the copy finishes.
  • Live status requires JavaScript and shows as stale after 30 seconds without an update; completed findings remain readable without JavaScript.
  • Protect access with your own server, VPN and sign-in. Never expose the report folder publicly.

Private Dokima.net teams

Manage your team, reports and subscriptions in your team account:

  • Roles: Viewers read reports. Admins manage invitations, members and connected installations. Owners also manage billing and add or remove owners.
  • Installations: Each connected installation uses a separate, revocable upload-only credential. Turning publishing off or revoking a credential stops future uploads without stopping local reviews. Deleting an installation in your account removes its hosted report immediately.
  • What is uploaded: Report findings, evidence (which may include code excerpts), repository and component names, remediation and review status. Dokima does not upload your repository checkout, runner prompts, credentials, raw logs or full local state.
  • Limits and retention: Hosted publishing accepts reports up to 8 MiB, up to 32 MiB of active report data per organisation and up to 50 connected installations. Only the latest report is kept per installation, and inactive reports expire after 30 days without contact. See the Privacy Notice and hosted data-processing terms.

Let coding agents review findings

Organisation owners and admins can create named, expiring, read-only API keys in Organisation → Agent API keys in your account. Agents can list connected installations and retrieve finding summaries, evidence and fix recommendations. Keys do not permit uploads, changing findings, billing or member administration. Follow the agent API guide for connection instructions.

Upload timing

Updated installations send one compressed exchange approximately every five minutes. It combines queued minimal product telemetry with the latest status and any changed report, if private publishing is enabled. Changes between exchanges are combined into the latest report. Local reviews and local status continue updating independently.

Dokima.net can increase the interval to as much as four hours. The policy arrives in the next scheduled response; no extra polling is needed. Restarts and retries cannot shorten the interval, and a small added random delay spreads traffic out. Hosted freshness indicators allow for the scheduled interval. Older clients retain their previous upload timing until updated.

Telemetry works independently of private publishing and never contains finding content, report data or source paths. It may include anonymous finding counts by severity and validation status, with keyed one-way identifiers used only to avoid double counting. Set DOKIMA_TELEMETRY=off in the worker environment to disable it. Unsent events are stored locally for up to seven days, with a maximum of 2,048 events; the oldest events are dropped if the queue fills. Explicit activation, licence refresh, downloads, updates and pairing remain available immediately.

Existing subscriptions and account security

  • Passkeys and recovery: Add passkeys in Account security and optionally require passkeys to sign in. Requiring passkeys disables password sign-in and email recovery, so keep an independent backup key; if you lose all passkeys, support cannot recover the account.