docs · get started

Chirkle documentation

Chirkle is a small, fast, real-time messenger that you run on your own server. It has rooms, direct messages, files, replies, mentions, reactions, search and full history, a native Android app, and it can link with other Chirkle servers and bridge rooms to Telegram groups.

The whole server is one program and one SQLite file. A $5 VPS with one CPU and 1 GB of RAM holds about 1,000 people chatting at a normal pace (how it was measured).

Where to start

What you get

  • Rooms that anyone can create, with three levels of access: Private (only the people you add), Public (everyone with an account) and Open Air (anyone can read, even without an account).
  • Direct messages between any two people.
  • Messages that update live everywhere: edits, deletes, replies with a quote, @mentions, emoji reactions, and forwarding up to 50 messages at once.
  • Files: up to 10 per message, 20 MB each, with an image viewer and a media grid for each room.
  • Collections of saved images and videos, private or public, which you can attach from and share.
  • Full history and search: scroll back to the very first message of any room, and search any room or DM.
  • Notifications of DMs, replies and mentions, with no Google, Apple or Mozilla push service involved.
  • An installable web app (PWA) and a native Android app, a 3 MB download.
  • For the server's admin: your own name and logo, invite-only signups, moderators, anonymous rooms, usage statistics, backups, S3 storage and password reset emails.

Try it first

The demo at chat.chirkle.com runs the latest version. Sign up there to look around before you install anything.

Get help

Questions, bug reports and ideas go to GitHub issues. The FAQ answers the common ones.

Edit this page on GitHub