docs · administration

Administration

This section is for whoever runs a Chirkle server. Most settings live in the admin UI, at /_/ on your server (for example https://chat.example.com/_/), which comes with every server. A few are environment variables, which take effect when the server restarts; the configuration reference lists them all.

The admin account

The admin UI has its own accounts, called superusers, separate from the accounts people chat with. Create the first one on the server:

$ npx chirkle superuser upsert you@example.com <password>

(with systemd, Docker and Dokku differ slightly.) Running it again with the same email changes that superuser's password.

Use a strong password: a superuser can read and change everything. To chat, sign up in the app like everyone else.

A checklist for a new server

  1. Set the public address. Settings → Application → Application URL: your server's address, like https://chat.example.com. Emails and linked servers need it.
  2. Name it. Your title and logo: Branding and signups.
  3. Decide who can sign up: open to anyone, or invite-only.
  4. Set up email, so people can reset forgotten passwords: Email.
  5. Schedule backups: Storage and backups.
  6. Choose moderators, if you want help: Moderators and statistics.

Where things are in the admin UI

WhatWhere
Title, logo, invite-only signups, statistics, linking, minimum Android versionCollections → site (one record)
People: moderators, bans, creating accounts, resetting passwordsCollections → users
Rooms: anonymous rooms, deleting a roomCollections → rooms
Telegram groupsCollections → tg_links (Telegram bridge)
Linked servers and shared roomsCollections → fed_peers, fed_shares (Linked servers)
Public address, trusted proxySettings → Application
EmailSettings → Mail settings
Files on S3Settings → Files storage
BackupsSettings → Backups
Rate limitsSettings → Rate limits
Request log and errorsLogs

Change the other collections only if you know what they do: the app keeps them consistent itself.

Pages in this section

Edit this page on GitHub