Tuwunel is a featureful Matrix homeserver you can use instead of Synapse with your favorite client, bridge or bot. It is written entirely in Rust to be a scalable, lightweight, low-cost, community-driven alternative covering all but the most niche uses.
This project is the official successor to conduwuit, which was a featureful and high-performance fork of Conduit, all community-lead homeservers implementing the compatible Matrix Specification.
Tuwunel is operated by enterprise users with a vested interest in sponsoring its continued development. It is now maintained by full-time staff.
- GitHub Releases
- Sourcecode
git clone https://github.com/matrix-construct/tuwunel.git - DockerHub or
docker pull jevolk/tuwunel:latest - GHCR or
docker pull ghcr.io/matrix-construct/tuwunel:latest - Static binaries available as releases or build artifacts.
- Deb and RPM packages available as releases or build artifacts.
- Arch package available as tuwunel or tuwunel-git.
- Nix package still needs some love.
1. Configure by
copying and editing the tuwunel-example.toml. The server_name and database_path must be
configured. Most users deploy via docker or a distribution package and should follow the
appropriate guide instead.
This is just a summary for the impatient. See the full
documentation.
Warning
Avoid using a sub-domain for your server_name. You can always delegate later with a .well-known
file, but you can never change your server_name.
2. Setup TLS certificates. Most users enjoy the Caddy reverse-proxy
which automates their certificate renewal. Advanced users can load their own TLS certificates
using the configuration and Tuwunel can be deployed without a reverse proxy. Example
/etc/caddy/Caddyfile configuration with Element
unzipped to /var/www/element:
https://tuwunel.me:8448 {
reverse_proxy http://127.0.0.1:8008
}
https://tuwunel.me:443 {
root * /var/www/element/
file_server
}
caddy reload --config /etc/caddy/Caddyfile
3. Start the server, connect your client and register your username. The first registration is granted server admin.
Tip
Configure a secret registration_token and set allow_registration = true
🤗 Did you find this and other documentation helpful? We would love to hear feedback about setting up Tuwunel.
| Can I migrate from | |
|---|---|
| conduwuit? | ✅ Yes. This will be supported at a minimum for one year, but likely indefinitely. |
| Synapse? | ❌ Not yet, but this is planned and an important issue. Subscribe to #2. |
| Conduit? | ❌ Not right now, but this is planned for the near future. Subscribe to #41. |
| Any other fork of Conduit? | ❌ No. The migration must be explicitly listed in this table. |
Caution
Never switch between different forks of Conduit or you will corrupt your database. All derivatives of Conduit share the same linear database version without any awareness of other forks. The database will permanently corrupt and we will not be able to help you.
Migrating from conduwuit to Tuwunel just works. In technical parlance it is a "binary swap."
All you have to do is update to the latest Tuwunel and change the path to the executable from
conduwuit to tuwunel.
Anything else named "conduwuit" is still recognized, this includes environment variables with prefixes
such as CONDUWUIT_. In fact, CONDUIT_ is still recognized for our legacy users. You may have
noticed that various configs, yamls, services, users, and other items were renamed, but if you
were a conduwuit user we recommend against changing anything at all. This will keep things simple.
If you are not sure please ask. If you found out that something did in fact need to be changed
please open an issue immediately.
We strive to make moving between versions of Tuwunel safe and easy. Downgrading Tuwunel is always safe but often prevented by a guard. An error will indicate the downgrade is not possible and a newer version which does not error must be sought.
Tuwunel uses a semantic version tag in the format of v<major>.<minor>.<patch>. The patch value will
always correspond to the number of commits from the last minor change with significance to developers.
The minor version is changed for fixes or features significant to users. The major value corresponds
to significant feature evolutions, and does not indicate any "breaking change" nor connote stability.
Important
Users should attempt to keep up to date with the latest minor version.
The main branch is always reasonably safe to run. We understand the propensity for users to simply clone
the main branch to get up and running, and we're obliged to ensure it's always viable. Nevertheless, only
tagged releases are true releases. If you don't care to update often, find the latest minor version
change rather than patch. We don't recommend simply following major version changes at this time.
Important
We strongly advise tracking the :latest tag when automatically updating.
Tracking :latest gives us the necessary discretion to keep you on the appropriate stable version.
We discourage tracking the main branch unless frequent restarts are acceptable. Alternatively,
tracking the :preview tag provides the latest release-candidate becoming equivalent to :latest
after a release. Tracking the :preview tag is a worthy alternative to the main branch, with
turbulence limited to release-time.
The official community will be found at #tuwunel:tuwunel.chat. If this is currently inaccessible please be patient as it's still coming online at the time of the first release; we will have updates to this section. This is a fully moderated space to protect the wellbeing of our users and create a non-toxic work environment for staff. If you require assistance with anything that is not remedied by the documentation, don't hesitate to open an issue on github.
If you are opposed to using github, or if private discussion is required such as for security disclosures, or for any other reason, I would be happy to receive your DM at @jason:tuwunel.me. This will not be bothering me as it would be my pleasure to help you anytime. As an emergency contact you can send an email to jasonzemos@gmail.com.
We also have an unofficial community-run chat which is publicly accessible at #tuwunel:grin.hu. The members, content, or moderation decisions of this room are not in any way related or endorsed by this project or its sponsors, and not all project staff will be present there. There will be at least some presence by staff to offer assistance so long as the room remains in minimally good standing.
Tuwunel's theme is empathy in communication defined by the works of Edith Stein. Empathy is the basis for how we approach every message and our responsibility to the other in every conversation.