diff --git a/docs/FAQ.md b/docs/FAQ.md new file mode 100644 index 000000000..9267aed32 --- /dev/null +++ b/docs/FAQ.md @@ -0,0 +1,60 @@ +# Frequently Asked Questions + +### Is Dendrite stable? + +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. + +### Is Dendrite feature-complete? + +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. + +### Is there a migration path from Synapse to Dendrite? + +No, not at present. There will be in the future when Dendrite reaches version 1.0. + +### I've installed Dendrite but federation isn't working + +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 + +### Does Dendrite work with my favourite client? + +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 + +### Does Dendrite support push notifications? + +No, not yet. This is a planned feature. + +### Does Dendrite support application services/bridges? + +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. + +### Is it possible to prevent communication with the outside world? + +Yes, you can do this by disabling federation - set `disable_federation` to `true` in the `global` section of the Dendrite configuration file. + +### Should I use PostgreSQL or SQLite for my databases? + +Please use PostgreSQL wherever possible, especially if you are planning to run a homeserver that caters to more than a couple of users. + +### Dendrite is using a lot of CPU + +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. + +### Dendrite is using a lot of RAM + +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. + +### Dendrite is running out of PostgreSQL database connections + +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! diff --git a/docs/PROFILING.md b/docs/PROFILING.md new file mode 100644 index 000000000..b026a8aed --- /dev/null +++ b/docs/PROFILING.md @@ -0,0 +1,89 @@ +# Profiling Dendrite + +If you are running into problems with Dendrite using excessive resources (e.g. CPU or RAM) then you can use the profiler to work out what is happening. + +Dendrite contains an embedded profiler called `pprof`, which is a part of the standard Go toolchain. + +## Enable the profiler + +To enable the profiler, start Dendrite with the `PPROFLISTEN` environment variable. This variable specifies which address and port to listen on, e.g. + +``` +PPROFLISTEN=localhost:65432 ./bin/dendrite-monolith-server ... +``` + +If pprof has been enabled successfully, a log line at startup will show that pprof is listening: + +``` +WARN[2020-12-03T13:32:33.669405000Z] [/Users/neilalexander/Desktop/dendrite/internal/log.go:87] SetupPprof + Starting pprof on localhost:65432 +``` + +All examples from this point forward assume `PPROFLISTEN=localhost:65432` but you may need to adjust as necessary for your setup. + +## Profiling CPU usage + +To examine where CPU time is going, you can call the `profile` endpoint: + +``` +http://localhost:65432/debug/pprof/profile?seconds=30 +``` + +The profile will run for the specified number of `seconds` and then will produce a result. + +### Examine a profile using the Go toolchain + +If you have Go installed and want to explore the profile, you can invoke `go tool pprof` to start the profile directly. The `-http=` parameter will instruct `go tool pprof` to start a web server providing a view of the captured profile: + +``` +go tool pprof -http=localhost:23456 http://localhost:65432/debug/pprof/profile?seconds=30 +``` + +You can then visit `http://localhost:23456` in your web browser to see a visual representation of the profile. Particularly usefully, in the "View" menu, you can select "Flame Graph" to see a proportional interactive graph of CPU usage. + +### Download a profile to send to someone else + +If you don't have the Go tools installed but just want to capture the profile to send to someone else, you can instead use `curl` to download the profiler results: + +``` +curl -O http://localhost:65432/debug/pprof/profile?seconds=30 +``` + +This will block for the specified number of seconds, capturing information about what Dendrite is doing, and then produces a `profile` file, which you can send onward. + +## Profiling memory usage + +To examine where memory usage is going, you can call the `heap` endpoint: + +``` +http://localhost:65432/debug/pprof/heap +``` + +The profile will return almost instantly. + +### Examine a profile using the Go toolchain + +If you have Go installed and want to explore the profile, you can invoke `go tool pprof` to start the profile directly. The `-http=` parameter will instruct `go tool pprof` to start a web server providing a view of the captured profile: + +``` +go tool pprof -http=localhost:23456 http://localhost:65432/debug/pprof/heap +``` + +You can then visit `http://localhost:23456` in your web browser to see a visual representation of the profile. The "Sample" menu lets you select between four different memory profiles: + +* `inuse_space`: Shows how much actual heap memory is allocated per function (this is generally the most useful profile when diagnosing high memory usage) +* `inuse_objects`: Shows how many heap objects are allocated per function +* `alloc_space`: Shows how much memory has been allocated per function (although that memory may have since been deallocated) +* `alloc_objects`: Shows how many allocations have been made per function (although that memory may have since been deallocated) + +Also in the "View" menu, you can select "Flame Graph" to see a proportional interactive graph of the memory usage. + +### Download a profile to send to someone else + +If you don't have the Go tools installed but just want to capture the profile to send to someone else, you can instead use `curl` to download the profiler results: + +``` +curl -O http://localhost:65432/debug/pprof/heap +``` + +This will almost instantly produce a `heap` file, which you can send onward. diff --git a/docs/hiawatha/monolith-sample.conf b/docs/hiawatha/monolith-sample.conf new file mode 100644 index 000000000..8285c0bd6 --- /dev/null +++ b/docs/hiawatha/monolith-sample.conf @@ -0,0 +1,17 @@ +# Depending on which port is used for federation (.well-known/matrix/server or SRV record), +# ensure there's a binding for that port in the configuration. Replace "FEDPORT" with port +# number, (e.g. "8448"), and "IPV4" with your server's ipv4 address (separate binding for +# each ip address, e.g. if you use both ipv4 and ipv6 addresses). + +Binding { + Port = FEDPORT + Interface = IPV4 + TLScertFile = /path/to/fullchainandprivkey.pem +} + +VirtualHost { + ... + ReverseProxy = /_matrix http://localhost:8008 600 + ... + +} diff --git a/docs/hiawatha/polylith-sample.conf b/docs/hiawatha/polylith-sample.conf index 99730efdb..5ed0cb5ae 100644 --- a/docs/hiawatha/polylith-sample.conf +++ b/docs/hiawatha/polylith-sample.conf @@ -1,3 +1,15 @@ +# Depending on which port is used for federation (.well-known/matrix/server or SRV record), +# ensure there's a binding for that port in the configuration. Replace "FEDPORT" with port +# number, (e.g. "8448"), and "IPV4" with your server's ipv4 address (separate binding for +# each ip address, e.g. if you use both ipv4 and ipv6 addresses). + +Binding { + Port = FEDPORT + Interface = IPV4 + TLScertFile = /path/to/fullchainandprivkey.pem +} + + VirtualHost { ... # route requests to: @@ -7,10 +19,10 @@ VirtualHost { # /_matrix/client/.*/keys/changes # /_matrix/client/.*/rooms/{roomId}/messages # to sync_api - ReverseProxy = /_matrix/client/.*?/(sync|user/.*?/filter/?.*|keys/changes|rooms/.*?/messages) http://localhost:8073 - ReverseProxy = /_matrix/client http://localhost:8071 - ReverseProxy = /_matrix/federation http://localhost:8072 - ReverseProxy = /_matrix/key http://localhost:8072 - ReverseProxy = /_matrix/media http://localhost:8074 + ReverseProxy = /_matrix/client/.*?/(sync|user/.*?/filter/?.*|keys/changes|rooms/.*?/messages) http://localhost:8073 600 + ReverseProxy = /_matrix/client http://localhost:8071 600 + ReverseProxy = /_matrix/federation http://localhost:8072 600 + ReverseProxy = /_matrix/key http://localhost:8072 600 + ReverseProxy = /_matrix/media http://localhost:8074 600 ... }