Documentation

What the docs cover#

These pages are reference documentation for people doing a task. They cover creating an account, setting up your first Product, installing the chat widget, connecting support email and running SupportSeal on your own server.

SupportSeal runs in two modes. The hosted service runs at dashboard.supportseal.app. You can also self-host the open source code. Where the two differ, the page says so.

The fast path#

Three steps take you from nothing to your first message in the inbox.

1. Create an account

   Register, then the setup wizard starts. On a self-hosted installation, the first visit goes to the registration page.

2. Add a Product and its domain

   The wizard asks for a Workspace name, a Product name and colour, and the hostnames where the widget will run.

3. Install the snippet and send a test message

   Paste the script tag before </body> on your site. Open the test page or your own site, then send a chat. The message appears in the inbox.

<script
  async
  src="https://dashboard.supportseal.app/widget.js"
  data-key="pk_…"
></script>

Your own key replaces pk_…. On a self-hosted installation, the script URL is your installation's public URL. Copy the exact tag from the wizard or from Product settings.

Guides#

• Getting startedRegister, run the setup wizard, land in the inbox and invite a teammate.
• Common setupDomains, support email, widget install, a second Product, a smoke test and troubleshooting.
• Self-hostingQuick start, environment reference, email, HTTPS and reverse proxy, backups, upgrades and uninstall.