Inboarddocs
For SaaS owners

Install templates

How an install template is built from requirements, resolved per platform, and published.

An install template is the configured set of requirements and steps for installing your product. It's the thing your installers actually follow inside the widget. You build one template per integration, and Inboard turns it into clear, platform-specific guides automatically.

What's inside a template

A template is made of requirements — each one is a single thing the installer must do, such as pasting a snippet, adding a DNS record, or entering an API key. Every requirement has a type that determines how it's presented and how it's verified.

You also define variables on the project: named placeholders like a domain or API key that get pre-filled per installer so every guide is copy-paste-ready.

How requirements become steps

You arrange requirements in the order an installer should complete them. Inboard renders that ordered list into numbered, step-by-step guides — one requirement maps to one step (or a short group of steps where a type needs both an action and a verification).

Because steps are generated from requirements rather than written by hand for each platform, you maintain the intent ("add this DNS record", "paste this snippet") in one place, and the per-platform wording is produced for you.

One template, many platform guides

The same template resolves to a different guide on each platform. An installer opens the widget, their platform is detected (or they pick it — WordPress, Shopify, Webflow, Squarespace, and more), and Inboard shows the steps tailored to that platform: the right admin paths, the right place to paste a snippet, the right way to add a record.

You don't author a separate template per platform. See Multi-platform guides for how resolution works and how to handle platform-specific differences.

Draft vs published

Every template has a draft and a published version.

  • Draft is your working copy. Edits, new requirements, and reordering all happen here. Drafts are not served to installers.
  • Published is the live version the widget renders. Publishing promotes your current draft to live.

This lets you stage changes safely and only expose them once you're confident.

The publish gate

Publishing is the point where a template goes live to real installers, so Inboard enforces two checks before it will publish:

  1. Domain ownership verification — the project's domain must be verified so guides are only served for domains you control. See Verification.
  2. Mandatory two-factor authentication — 2FA is required at the publish step. If your account doesn't have it enabled, you'll be prompted to set it up before you can publish.

Both must pass on every publish, not just the first one.

Requirement types

A template can mix any of the eight requirement types. Each links to its own page with configuration and verification details.

TypeWhat the installer does
Code snippetPastes an HTML/JS snippet into their site.
DNS recordAdds a DNS record at their domain provider.
API keyEnters an API key into a field.
CommandRuns a command in a terminal or shell.
DownloadDownloads and installs a file or package.
WebhookConfigures a webhook endpoint.
HTTP checkConfirms an endpoint responds correctly.
Custom verifyCompletes a step validated by your own server.

On this page