FAQ
Much of this content comes from element-hq/dendrite and may be out of date after the many changes in this fork. Use it with caution, and report drift in an issue or pull request.
Why does Zendrite exist?
Section titled “Why does Zendrite exist?”Zendrite is a Matrix-compatible server that uses fewer resources than Synapse. It also gives more flexibility when scaling up or down. Its code is easy to change, which makes it suitable for experimenting with new Matrix features. It was forked from Dendrite to add significant features, optimisations, and fixes.
Is Zendrite stable?
Section titled “Is Zendrite stable?”Mostly. It advertises Matrix spec versions up to v1.19, and it’s much more stable than Dendrite used to be. If you’re a confident power user, try Zendrite.
Is Zendrite feature-complete?
Section titled “Is Zendrite feature-complete?”For the Matrix specification, mostly. Zendrite advertises spec versions up to v1.19, and the client API conformance audit records the evidence. Some proposals (MSCs) that clients use but that aren’t in a spec release yet are still missing. Issue #558 tracks them, and MSC support lists what’s implemented.
Is there a migration path from Dendrite to Zendrite?
Section titled “Is there a migration path from Dendrite to Zendrite?”Yes, see Migration from Dendrite.
Is there a migration path from Synapse to Zendrite?
Section titled “Is there a migration path from Synapse to Zendrite?”There’s a migration script, but it’s unsupported and may need maintenance. If you consider it, take backups and test carefully first.
Can I use Zendrite with an existing Synapse database?
Section titled “Can I use Zendrite with an existing Synapse database?”No. Zendrite’s database schema is very different from Synapse’s, and the two aren’t interchangeable.
Can I configure which port Zendrite listens on?
Section titled “Can I configure which port Zendrite listens on?”Yes, use the -http-bind-address command-line flag.
I’ve installed Zendrite but federation isn’t working
Section titled “I’ve installed Zendrite but federation isn’t working”Check the Federation Tester. You need at least:
- A valid domain name
- A valid TLS certificate for that domain name
- Either SRV records or well-known files, see Well-known delegation
Whenever I try to connect from Element it says unable to connect to homeserver
Section titled “Whenever I try to connect from Element it says unable to connect to homeserver”Check that your Zendrite instance is running. If it is, the cause is most likely a misconfigured reverse proxy.
Does Zendrite work with my favourite client?
Section titled “Does Zendrite work with my favourite client?”It should. If a client misbehaves with Zendrite, open an issue.
Is there a public instance of Zendrite I can try out?
Section titled “Is there a public instance of Zendrite I can try out?”No, there is no public Zendrite instance.
Does Zendrite support Space Summaries?
Section titled “Does Zendrite support Space Summaries?”Yes.
Does Zendrite support Threads?
Section titled “Does Zendrite support Threads?”Yes, threads (m.thread relations) work without any configuration.
The older threading proposal MSC2836 is a different, experimental feature that clients don’t use for threads.
You can opt into it in the mscs configuration:
See MSC support for the other proposals Zendrite implements. Treat opt-in MSCs as experimental, because enabling them can cause significant usability problems. For how MSCs are ratified and their current status, see the Matrix specification documentation.
Does Zendrite support push notifications?
Section titled “Does Zendrite support push notifications?”Yes. Configure them as usual in your Matrix client.
Does Zendrite support application services/bridges?
Section titled “Does Zendrite support application services/bridges?”Partly. Zendrite has some application service support, but it isn’t well tested. If you try it and run into problems, open an issue.
Bridges known to work:
Add each bridge’s registration file to the app_service_api section of the Zendrite config file.
Is it possible to prevent communication with the outside world?
Section titled “Is it possible to prevent communication with the outside world?”Yes, disable federation.
Set disable_federation to true in the global section of the Zendrite config file.
How can I migrate a room to change its internal ID?
Section titled “How can I migrate a room to change its internal ID?”Upgrade the room.
In Element, run /upgraderoom <version>.
How do I reset somebody’s password on my server?
Section titled “How do I reset somebody’s password on my server?”Use the resetPassword admin endpoint.
Should I use PostgreSQL or SQLite for my databases?
Section titled “Should I use PostgreSQL or SQLite for my databases?”Use PostgreSQL wherever possible, especially if your homeserver serves more than a couple of users.
What data needs to be kept if transferring/backing up Zendrite?
Section titled “What data needs to be kept if transferring/backing up Zendrite?”Keep these files:
matrix_key.pemzendrite.yaml- the PostgreSQL or SQLite database
- the JetStream directory
- the media store
- the search index (Zendrite can regenerate it)
This list may be out of date. There are no official instructions for migrations like this.
How can I prepare enough storage for media caches?
Section titled “How can I prepare enough storage for media caches?”Try matrix-media-repo. Zendrite doesn’t officially support it or any other dedicated media storage solution.
Zendrite is using a lot of CPU
Section titled “Zendrite is using a lot of CPU”Expect some CPU spikes, especially when you join or take part in large rooms. Constant high CPU usage isn’t expected. If you see it, open an issue and describe what you were doing when the CPU usage rose. A CPU profile helps a lot, because it shows where the CPU time goes.
Zendrite is using a lot of RAM
Section titled “Zendrite is using a lot of RAM”As with CPU usage, expect some memory spikes while Zendrite does heavy work. If it uses more RAM than you expect for a long time, that’s probably a problem. A memory profile helps a lot, because it shows where the memory goes.
Do I need to generate the self-signed certificate if I’m going to use a reverse proxy?
Section titled “Do I need to generate the self-signed certificate if I’m going to use a reverse proxy?”No. If your reverse proxy terminates TLS with a proper certificate from a provider such as Let’s Encrypt, you can use HTTP between the proxy and the Zendrite process.
Zendrite is running out of PostgreSQL database connections
Section titled “Zendrite is running out of PostgreSQL database connections”Raise the connection limit (max_connections) of your PostgreSQL server, lower the connection limits in your Zendrite configuration, or both.
With the global.database pool, all components share one pool, so its max_open_conns is the limit for the whole server.
Each component with its own database block and a different connection string opens a separate pool, and its limit adds to the global one.
VOIP and Video Calls don’t appear to work on Zendrite
Section titled “VOIP and Video Calls don’t appear to work on Zendrite”Your server’s STUN/TURN configuration is the likely cause. If you believe your configuration is correct, see Troubleshooting.
What is being reported when enabling phone-home statistics?
Section titled “What is being reported when enabling phone-home statistics?”Phone-home statistics contain your server’s domain name, some information about your deployment’s configuration, and aggregated information about its active users. Zendrite sends them only to the endpoint URL configured in your Zendrite configuration file. Here is an example of the data it sends: