Skip to content
Komozu Docs

Getting started

Komozu is a chat for the signed-in users of your website or app. The dashboard sets up the channels, the look and the moderation; your server identifies each user with a member token. Without a token, the chat shows nothing but a prompt to sign in on your site: nobody posts anonymously.

1. Create a project

Section titled “1. Create a project”

A project is your website or app. Click New project: the onboarding walks you through the next steps.

  • Projects start on the Free plan (Plan & usage page). An account can have up to 2 projects on the Free plan; projects on a paid plan don’t count.
  • The publishable key (kz_live_…) is safe in your website. The secret key (kz_sec_…) is shown once, at the end of the onboarding: keep it on your server, it creates your members and their tokens.

2. Create a channel

Section titled “2. Create a channel”

A channel is one conversation: your club’s general chat, a group, an event. You choose:

  • a name (the identifier, e.g. general, is generated from it and never changes);
  • an access:
    • Members (default): every member of your project, i.e. every signed-in user your server identified;
    • Private: only the members you add to the channel.

In the channel’s Settings tab you can also turn Images & videos on or off (on by default, 10 MB max per file). The setting belongs to the channel: every way of showing it follows it. On the Free plan, people can share images only: videos come with paid plans.

3. Add an integration

Section titled “3. Add an integration”

An integration is one way of showing a channel on a site, set up in the dashboard. A channel can have several (for example one inside a page and one floating bubble). In the channel page → Integrations → New integration, pick:

SettingOptions
ModeInline (part of your page) or Floating bubble (bottom corner)
SurfaceCard (framed, default) or Blend (melts into your page)
HeightAuto (grows up to a maximum, 600 px by default) or Fixed, inline only
ColorProject color (Settings) or a custom color
AppearanceAuto (follows the visitor’s system), Light, Dark. Visitors can still switch from the chat
Where will you add it?Optional: your site’s domain, added to the allowed domains

The preview on the right is the real chat with sample messages.

4. Paste the code and write the token

Section titled “4. Paste the code and write the token”

Save: the code panel shows the script to paste, where the chat should appear (once, anywhere, for the bubble):

<script src="https://embed.komozu.com/komozu-embed.js" data-komozu-integration="int_…" data-komozu-token="MEMBER_TOKEN" defer></script>

Your server replaces MEMBER_TOKEN with the token of the signed-in user (empty for a visitor who isn’t signed in): see Identify your users. The code only contains the integration id and the token: change the look in the dashboard and your site picks it up on the next page load, no redeploy.

Developers also get a React tab (<KomozuChat clientId="kz_live_…" channel="general" token={user.komozuToken} />, with the same look) and a JavaScript tab (@komozu/core).

Copy instructions for an AI copies the code with step-by-step instructions (the member token from your server, how to check it works): paste them in your AI assistant.

Open a test page (onboarding, last step) shows your chat on a sample site with real messages. You post as the project’s test member, Test (created on first use, listed in Members).

5. Moderate, pin and post

Section titled “5. Moderate, pin and post”

The channel’s Conversation tab shows the chat live, as your members see it:

  • Post in the chat: your messages show your account name (or the project name when your account has none) and the Admin badge. Edit them from their ⋯ menu.
  • The ⋯ menu next to each message pins or unpins it, deletes it, or bans its author from the whole project.

Pinned messages: the latest one stays at the top of the chat; a button next to it opens the list of every pinned message (50 per channel at most), inside the chat. A click on one goes back to the conversation, right at that message.

Channel admins: in the channel’s Members tab (Admins for a Members channel), make some of your members admin. In the chat, an admin has the Admin badge and, in the ⋯ menu of each message: pin / unpin, delete, and remove a member (private channels). An admin acts on that channel only. On a Members channel, being admin adds rights, never access; on a Private channel, making a member admin also adds them to it. Banning a member from the whole project stays with you.

Reports: every member can report a message from the chat (optional reason), admins’ messages and yours included. You get an email (one at most every 15 minutes per project) and the message waits in the project’s Reports page, shown as in the chat with its photos and videos: delete it, ban its author, or dismiss the report to keep it. The Overview reminds you when reports are waiting. Your backend can do the same with reports.list / reports.dismiss.

Language

Section titled “Language”

The chat is in English or French: it follows the visitor’s browser language (English when it’s another language). To force one, see Advanced embed.

Next steps

Section titled “Next steps”