Refleks

Refleks documentation

Install Refleks on your website

The dashboard generates a site-bound widget script, detects common platforms, and checks the published output after you deploy.

Before you begin

A few checks prevent the most common setup dead ends.

  • Create an account and verify its email address. Email verification is required before adding a site or starting a crawl.
  • Use a publicly reachable website URL. The crawler does not sign in to a website or use a customer’s session cookies.
  • Have access to your site’s global layout, footer, theme, custom-code area, or tag manager. The script must load on every page where you want the assistant.

1. Add and index a site

  1. Open the dashboard and choose Add a site.
  2. Enter the published URL and an optional name. The URL becomes the crawl origin; its hostname determines the crawl boundary.
  3. Choose Crawl and index. The initial job is queued after ownership, plan, cooldown, and daily-cap checks.
  4. Watch the site page while the job moves through fetching and indexing. Test the assistant from the dashboard after an active index is ready.

If a site cannot be fetched or should not be crawled, the dashboard also offers a manual text path. It accepts pasted content or .txt, .md, .csv, and .json files within the limit shown in the form. This is an import path, not an authenticated crawler.

2. Add the generated widget script

Copy the exact snippet from the site’s Installation tab. It contains the site key, the Refleks app origin, the versioned loader URL, and an integrity value.

<script
  src="https://YOUR_REFLEKS_APP/widget/v0.8.0.js"
  data-widget-key="YOUR_SITE_WIDGET_KEY"
  integrity="sha384-…"
  crossorigin="anonymous"
  async></script>

The example intentionally uses placeholders. Do not hand-edit the key or integrity value; copy the current script from the dashboard. Place it before </body> in the global layout and publish the site.

Platform paths

The dashboard can identify signals for the platforms below. Detection is a hint for choosing instructions, not a promise that a platform’s current editor has the same menu names.

WordPress

Use a site-wide footer/header code plugin or the theme’s global footer.

Shopify

Add the script to the published theme’s layout, usually theme.liquid.

Wix

Use the site-wide Custom Code area and place it at the end of body.

Webflow

Use project Site Settings → Custom Code → Footer Code.

Squarespace

Use Code Injection → Footer when available on the plan.

Framer

Use site settings custom code at the end of body.

Next.js

Add it to the root layout or next/script so it appears on the intended pages.

Custom / unknown

Use the global template, layout, footer, or tag manager and ask a developer if needed.

Platform-specific instructions are convenience guidance. If your provider’s interface differs, the reliable requirement is still the same: the published HTML or framework output must reference the current Refleks loader and key on the pages where it should appear.

3. Verify the published install

Select Verify installation in the dashboard after publishing. The server fetches the configured site URL and checks for the loader, the expected site key, the expected Refleks app origin, and HTTPS. It accepts both a normal script tag and a framework/reference pattern, which is useful for Next.js or tag managers.

Supported

Installed

The expected script, key, origin, and HTTPS checks pass in the fetched output.
Conditional

Framework reference

The URL and key are present in output but not as a plain script tag. A browser check may still be needed.
Not supported

Not proof of ownership

This check is an output probe, not DNS, TXT-record, or legal domain ownership verification.

A tag manager can load code after the initial HTML response, so raw verification may report a missing script even when the browser displays the widget. If it still does not appear, see CSP and origins and installation troubleshooting.

What is not part of installation?

  • There is no separate DNS verification workflow in the current product.
  • The widget loader requires HTTPS in production. HTTP is accepted only for localhost development paths.
  • Adding the script does not crawl a site or make an assistant ready by itself; the site needs an active indexed snapshot first.

Next: read how content is selected or configure the widget.