Docs

Quickstart

From zero to a live chat in about two minutes.

1. Create your app

Sign up, name your app and pick an accent color. octokan creates an app key that looks like app_1a2b3c4d5e6f.

2. Paste one line

Add this before the closing body tag of your site. That's the entire install.

<script src="https://YOUR-BACKEND/octokan.js" data-app-id="app_xxxxxxxxxxxx" defer></script>

Your exact line, with your key and backend URL filled in, is on the Install page in the dashboard.

3. Confirm it's live

Open your site. The Install page flips to Live on yoursite.com the moment the script loads. Click Try it here to send yourself a first message.

4. Add your domain

Under Settings > Install & identity, list your production domains so no other site can load your chat.

NextInstall on Next.js→