selfhost.directory

The index of self-hostable projects — ranked, categorized and served with live updates.
Own your data and stop giving it to big tech.

GitHub
Chatterbox logo

Self-host Chatterbox

v0.5.2

Embeddable Matrix chat widget for websites

BetaOpen CoreAGPL-3.0
Updatedlast year
LanguageTypescript
Setup difficultyAdvanced
Stars
182
Port
8080 (HTTP server for embeddable chat widget assets)
Install with Docker
Chatterbox client screenshot showing the embeddable chat widget

What is Chatterbox?

Chatterbox is an embeddable chat widget that securely embeds the Hydrogen Matrix client into any website. It uses token-authenticated registration with a Synapse homeserver to create anonymous chat sessions for website visitors. The widget can be configured to auto-join a room, invite a specific user, and customize the header and footer. It is built with TypeScript and Vite, and can be self-hosted using the provided Dockerfile which serves the built assets via nginx on port 8080. The project is multi-licensed under AGPL-3.0-or-later or a commercial Element license.

Should you self-host Chatterbox?

Chatterbox scores 40/100 on selfhost.directory (how scoring works) and ranks #85 of 110 in Chat. It has 182 GitHub stars.

There was no stable release in the past 12 months, so check the repository's recent activity before you rely on it.

Setup is advanced: plan for several services and some ongoing maintenance. It is AGPL-3.0-licensed and written mostly in Typescript.

Its closest alternative on selfhost.directory is Zulip (82/100, 26 131 stars). It scores higher overall, so compare the two before you pick. See Chatterbox vs Zulip side by side.

Features

  • Auto-join room
  • Customizable header and footer
  • Direct message to operator
  • Embeddable chat widget
  • End-to-end encryption
  • Operator join gating
  • Sentry error tracking
  • Token-authenticated registration

Chatterbox README

How to install Chatterbox

Install Chatterbox with Docker

FROM node:16 AS build

WORKDIR /app

COPY package.json /app/package.json

RUN yarn install

COPY . .

RUN yarn build

FROM nginxinc/nginx-unprivileged:1.21.6

COPY ./default-nginx.conf /etc/nginx/conf.d/default.conf COPY --from=build /app/target/assets /usr/share/nginx/html/assets COPY --from=build /app/target/chatterbox.html /usr/share/nginx/html/chatterbox.html

Multi-stage Dockerfile builds the app and serves via nginx on port 8080

Chatterbox releases & version history

More in Customer Support

Rate this project

Click to rate — no account needed.

0 comments

Posting as guest
Loading comments…