DOKIMA

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 nothing 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).

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, claim existing subscriptions 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.

Existing subscriptions and account security

  • Claiming a subscription: In the Billing tab of your team account, verify the original billing email to find and claim an existing subscription. Existing licences, download links and activations continue working without reactivation.
  • 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.