Quick start

By the end of this guide you'll have a working install template embedded on a page of your choice. You'll need an Inboard account (free for 50 installs/month) and the embed key for the install template you want to use.

1. Create an install template

Sign in at app.inboard.dev and create a project. The onboarding wizard walks you through:

• Branding — name, logo, and primary colour.
• Detection — the domain or URL pattern that identifies a site running your product.
• Steps — the actions a customer takes to install your product (add a script, set a DNS record, paste an API key, etc.).

When you finish the wizard, the project page shows your embed key — a short opaque string like tpl_abc123. Copy it.

2. Add the script tag

Drop the snippet below into the page where you want the install template to appear. The widget mounts itself into the <div id="inboard"> placeholder.

<div id="inboard"></div>

<script
  src="https://app.inboard.dev/widget/inboard-widget.js"
  data-embed-key="tpl_abc123"
  data-target="#inboard"
  defer
></script>

The widget loads asynchronously and renders a step-by-step walkthrough tailored to the visitor's platform. No build step, no framework integration, no API keys exposed in the browser.

3. (Optional) Pre-fill variables

If your install steps reference customer-specific values — a domain, an API key, an account ID — pass them through the data-variables attribute as JSON:

<script
  src="https://app.inboard.dev/widget/inboard-widget.js"
  data-embed-key="tpl_abc123"
  data-target="#inboard"
  data-variables='{"domain":"acme.com","apiKey":"sk_live_..."}'
  defer
></script>

Variable names match the placeholders you defined in the template editor (see Variables).

4. Verify the install

Open the page in a browser. You should see:

• The Inboard install template render inside the placeholder.
• Platform auto-detection succeed (or a searchable picker if it can't).
• Each step show its specific instructions and screenshots.

If the widget doesn't render, open the browser console — every error from the widget logs a [Inboard] prefix so you can spot it quickly.

Next steps

• Configuration — every supported attribute and Inboard.init() option.
• Variables — how to define, reference, and pass variables.
• Custom styling — match the widget to your brand.