HideGuardDocumentation

Dashboard · The console

Get started

The setup checklist, and how it measures its own progress.

The checklist for getting a site live. The progress ring on the rail reads from this same list.

The steps#

  1. Create a site: get the public key and the secret, declare the allowed origins.
  2. Add the SDK, one <script> tag at the end of <body>.
  3. Receive your first visit: load your page and watch it arrive.
  4. Add the server-side check: call POST /api/v1/verdict where something of value changes hands.

The page gives you snippets built from your site's real key, with copy buttons. There is also a copy as prompt button if you would rather hand the work to an agent.

How progress is measured#

Each step is confirmed by something that actually happened, not by a checkbox:

StepCounted as done when
Create a siteThe workspace holds at least one site
Add the SDKA visit has been recorded from that site
Server checkA call to /api/v1/verdict has been counted

When a step cannot be measured, the database did not answer, say, the ring shows checking rather than not done.

When step 3 will not go green#

In this order:

  1. Open Health. If anything was refused, it says why: a bad key, a disallowed origin, a malformed body.
  2. Check your page's origin is on the site's allowlist.
  3. Check data-site-key is the public key (pk_), not the secret.
  4. Open the browser console, an ad blocker can stop the script loading at all.