فارسی · Home · Setup guide
Screenshots
A tour of interzone, screen by screen, on a demo server at example.org.
Every screenshot is 1600×900; click one to see it full size. The sidebar on
the left is always there: Setup, Manage, Mirrors, Test,
Host and Servers. ctrl+k jumps to any screen by name, and ? lists
the keys of the one you're on.
Setting up
Welcome
The first screen. enter starts the setup; i takes over a server you set
up with the playbook yourself. Once a server is installed, interzone opens on
Manage instead.
Server
Where Matrix goes and how to get there: the base domain, this machine or a
server over SSH, and further down Downloads (normal internet, blackout
mirrors or IPFS) and HTTPS certificates. ctrl+t tests every download
source from here.
Homeserver
Start from a preset, or pick only the homeserver: Synapse, Continuwuity, Tuwunel, Conduit or Dendrite. The highlighted preset shows exactly which components it brings.
Components
All 63 bridges, bots, clients and services, in tabs by category. The card
on top says what the chosen one does and where its docs are; needs
settings means the next step asks for something. / searches all of them.
Settings
What the components need: your admin account (the password is made up for
you; ctrl+r shows it), each component's settings and the web apps'
addresses. Advanced on the right holds every other playbook setting.
Review
Before anything is installed, interzone checks the server, DNS, federation and
ports, and lists what a firewall must let in. Pressing enter asks once
more, as here; y deploys.
Deploy
The install, step by step, with the playbook's tasks streaming below. It usually takes 10 to 30 minutes.
When it's done: your server's addresses, the admin account, and which services answered the self-check.
Managing the server
Manage
Everything to keep the server running, grouped: updates, checks and restarts; people and rooms; backups. Each action has a letter, shown on the right. The top bar shows the server is up and how long its certificate has left.
? on any screen lists every key it has, and the ones that work anywhere.
Dashboard
CPU, memory, disk and containers, refreshed every few seconds; the heaviest containers, the next backup, and the last 14 days below.
Users
Totals on top, then everyone on the server, with search, filters and sorting. The card shows when someone was last seen, their sessions, rooms and media; from it you can set a new password, make an admin, sign them out everywhere or deactivate them. Bridged accounts are grouped by bridge.
Rooms
Every room with what it takes on disk, its history and media included. o
sorts by size, members, newest or media. From a room's card you can block it,
delete its old history or delete it.
Sign-up tokens
Invite codes for registration: how often each was used, when it expires, and
the one interzone made itself. n makes a new one, x revokes one.
Updates and going back
What's new
Before an update: the playbook's changelog entries about what your server
runs, every version that changes, and the commits. enter updates, d does
a dry run first.
Roll back
Every successful deploy is recorded with the playbook's commit and your answers, so you can go back to any of them.
Backups
Scheduled database backups the server makes by itself, even when your
computer is off. ctrl+d copies them to this machine.
Restore
The database dumps on this machine, newest first. enter puts one back.
Keeping an eye on it
Alerts
The server checks itself and sends a message when something breaks and when it's fixed: failed services, the homeserver not answering, a certificate about to expire, a full disk. It can send to ntfy, a webhook or a Matrix room.
Maintenance
The playbook's upkeep jobs: start or stop services, free disk space, vacuum or compress the database, upgrade Postgres, run chosen playbook tags, and uninstall.
Fine-tune
Every setting of every role in the playbook, those your server uses first.
/ searches all of them, and c shows only what you've changed.
More servers
Servers
interzone can manage several servers, each with its own answers and playbook
copy. n adds one, i imports one set up by hand.
Move server
Moves everything to another machine: the database, media, and the bridges' data and keys. The old server's files stay until you delete them.
Mirrors, tests and IPFS
Mirrors
Is everything there to download? Three tabs check the playbook and its roles, the package and image mirrors, and every container image your setup needs. Here a role's version is missing from the git mirror.
Test servers
Test any Matrix server, yours or someone else's: DNS, IPv4 and IPv6, TLS,
federation, what apps and Element X need, sign-ups, and who to ask for help.
ctrl+o copies the result, ctrl+r tests again every 30 seconds.
Host for IPFS
On a machine sharing interzone's mirror over IPFS: every node in the swarm on a map of Iran, what this node sends and receives, its busiest peers, and who came and went.