Quick start

This walkthrough takes you from zero to a working, embedded install template with one verified requirement. You'll need about five minutes and a page where you can paste a script tag. Inboard is free for 50 installs/month, so you don't need a paid plan to follow along.

1. Sign up

Create an account at app.inboard.dev. The free plan is enough for everything in this guide.

2. Create a project

A project is the container for one product integration. Create one and give it a name — this is where your branding, allowed domains, and widget style live. See Projects for the full picture.

3. Add your first install template

Inside your project, create an install template and add a single requirement to start. Pick the code snippet type and give it a snippet your installer would paste into their site, for example:

<script src="https://cdn.acme.com/acme.js" data-account="ACME123"></script>

One requirement is all you need to see the flow end to end. You can add DNS records, API keys, commands, and more once the basics work — see Install templates.

4. Grab the embed key

When your install template is ready, the project gives you an embed key — a short, opaque string that looks like tpl_abc123. Copy it; the widget uses it to know which install template to render.

5. Embed the widget

Drop this snippet into the page where you want the guide to appear. The widget mounts itself into the #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>

Replace tpl_abc123 with your own embed key. That's the entire integration — no build step, no framework, no secrets in the browser.

6. Watch a test install and verification

Open the page in a browser. You should see:

• The widget render your install template inside the placeholder.
• Platform auto-detection succeed, or a searchable picker if it can't.
• Your code-snippet requirement show its instructions.

Complete the step the way an installer would, then let Inboard verify it. Depending on the requirement, verification is an automatic HTTP check, a self-report confirmation, or a custom server-side check. A green result means the install is done correctly.

Next steps

• Install templates — add more requirements, types, and verification methods.
• Configuration — the full set of embed attributes and the Inboard.init() JavaScript API for integrators.