dendrite/docs/FAQ.md

119 lines
5.8 KiB
Markdown
Raw Normal View History

2020-12-03 13:22:32 +00:00
# Frequently Asked Questions
2020-12-03 13:28:41 +00:00
### Is Dendrite stable?
2020-12-03 13:22:32 +00:00
Mostly, although there are still bugs and missing features. If you are a confident power user and you are happy to spend some time debugging things when they go wrong, then please try out Dendrite. If you are a community, organisation or business that demands stability and uptime, then Dendrite is not for you yet - please install Synapse instead.
2020-12-03 13:28:41 +00:00
### Is Dendrite feature-complete?
2020-12-03 13:22:32 +00:00
No, although a good portion of the Matrix specification has been implemented. Mostly missing are client features - see the readme at the root of the repository for more information.
2020-12-03 13:28:41 +00:00
### Is there a migration path from Synapse to Dendrite?
2020-12-03 13:22:32 +00:00
No, not at present. There will be in the future when Dendrite reaches version 1.0.
2022-03-18 11:44:13 +00:00
### Can I use Dendrite with an existing Synapse database?
No, Dendrite has a very different database schema to Synapse and the two are not interchangeable.
2020-12-07 10:20:19 +00:00
### Should I run a monolith or a polylith deployment?
Monolith deployments are always preferred where possible, and at this time, are far better tested than polylith deployments are. The only reason to consider a polylith deployment is if you wish to run different Dendrite components on separate physical machines.
2020-12-03 13:28:41 +00:00
### I've installed Dendrite but federation isn't working
2020-12-03 13:22:32 +00:00
Check the [Federation Tester](https://federationtester.matrix.org). You need at least:
* A valid DNS name
* A valid TLS certificate for that DNS name
* Either DNS SRV records or well-known files
2020-12-03 13:28:41 +00:00
### Does Dendrite work with my favourite client?
2020-12-03 13:22:32 +00:00
It should do, although we are aware of some minor issues:
* **Element Android**: registration does not work, but logging in with an existing account does
* **Hydrogen**: occasionally sync can fail due to gaps in the `since` parameter, but clearing the cache fixes this
2020-12-03 13:28:41 +00:00
### Does Dendrite support push notifications?
2020-12-03 13:22:32 +00:00
2022-03-18 11:44:13 +00:00
Yes, we have experimental support for push notifications. Configure them in the usual way in your Matrix client.
2020-12-03 13:22:32 +00:00
2020-12-03 13:28:41 +00:00
### Does Dendrite support application services/bridges?
2020-12-03 13:22:32 +00:00
Possibly - Dendrite does have some application service support but it is not well tested. Please let us know by raising a GitHub issue if you try it and run into problems.
Bridges known to work (as of v0.5.1):
- [Telegram](https://docs.mau.fi/bridges/python/telegram/index.html)
- [WhatsApp](https://docs.mau.fi/bridges/go/whatsapp/index.html)
- [Signal](https://docs.mau.fi/bridges/python/signal/index.html)
- [probably all other mautrix bridges](https://docs.mau.fi/bridges/)
Remember to add the config file(s) to the `app_service_api` [config](https://github.com/matrix-org/dendrite/blob/de38be469a23813921d01bef3e14e95faab2a59e/dendrite-config.yaml#L130-L131).
2020-12-03 13:28:41 +00:00
### Is it possible to prevent communication with the outside world?
2020-12-03 13:27:48 +00:00
Yes, you can do this by disabling federation - set `disable_federation` to `true` in the `global` section of the Dendrite configuration file.
2020-12-03 13:28:41 +00:00
### Should I use PostgreSQL or SQLite for my databases?
2020-12-03 13:27:48 +00:00
Please use PostgreSQL wherever possible, especially if you are planning to run a homeserver that caters to more than a couple of users.
2020-12-03 13:28:41 +00:00
### Dendrite is using a lot of CPU
2020-12-03 13:22:32 +00:00
Generally speaking, you should expect to see some CPU spikes, particularly if you are joining or participating in large rooms. However, constant/sustained high CPU usage is not expected - if you are experiencing that, please join `#dendrite-dev:matrix.org` and let us know, or file a GitHub issue.
2020-12-03 13:28:41 +00:00
### Dendrite is using a lot of RAM
2020-12-03 13:22:32 +00:00
A lot of users report that Dendrite is using a lot of RAM, sometimes even gigabytes of it. This is usually due to Go's allocator behaviour, which tries to hold onto allocated memory until the operating system wants to reclaim it for something else. This can make the memory usage look significantly inflated in tools like `top`/`htop` when actually most of that memory is not really in use at all.
If you want to prevent this behaviour so that the Go runtime releases memory normally, start Dendrite using the `GODEBUG=madvdontneed=1` environment variable. It is also expected that the allocator behaviour will be changed again in Go 1.16 so that it does not hold onto memory unnecessarily in this way.
If you are running with `GODEBUG=madvdontneed=1` and still see hugely inflated memory usage then that's quite possibly a bug - please join `#dendrite-dev:matrix.org` and let us know, or file a GitHub issue.
2020-12-03 13:28:41 +00:00
### Dendrite is running out of PostgreSQL database connections
2020-12-03 13:22:32 +00:00
2020-12-03 13:27:48 +00:00
You may need to revisit the connection limit of your PostgreSQL server and/or make changes to the `max_connections` lines in your Dendrite configuration. Be aware that each Dendrite component opens its own database connections and has its own connection limit, even in monolith mode!
### What is being reported when enabling anonymous stats?
If anonymous stats reporting is enabled, the following data is send to the defined endpoint.
```json
{
"cpu_average": 0,
"daily_active_users": 97,
"daily_e2ee_messages": 0,
"daily_messages": 0,
"daily_sent_e2ee_messages": 0,
"daily_sent_messages": 0,
"daily_user_type_bridged": 2,
"daily_user_type_native": 97,
"database_engine": "Postgres",
"database_server_version": "11.14 (Debian 11.14-0+deb10u1)",
"federation_disabled": false,
"go_arch": "amd64",
"go_os": "linux",
"go_version": "go1.16.13",
"homeserver": "localhost:8800",
"log_level": "trace",
"memory_rss": 93452,
"monolith": true,
"monthly_active_users": 97,
"nats_embedded": true,
"nats_in_memory": true,
"num_cpu": 8,
"num_go_routine": 203,
"r30v2_users_all": 0,
"r30v2_users_android": 0,
"r30v2_users_electron": 0,
"r30v2_users_ios": 0,
"r30v2_users_web": 0,
"timestamp": 1651741851,
"total_nonbridged_users": 97,
"total_room_count": 0,
"total_users": 99,
"uptime_seconds": 30,
"version": "0.8.2"
}
```