{"id":31629302,"url":"https://github.com/matrix-construct/tuwunel","last_synced_at":"2026-03-08T01:31:09.952Z","repository":{"id":278968904,"uuid":"936800411","full_name":"matrix-construct/tuwunel","owner":"matrix-construct","description":"Official successor to conduwuit","archived":false,"fork":false,"pushed_at":"2025-09-30T04:02:20.000Z","size":12760,"stargazers_count":699,"open_issues_count":67,"forks_count":38,"subscribers_count":10,"default_branch":"main","last_synced_at":"2025-09-30T04:11:48.345Z","etag":null,"topics":["chat","conduit","conduwuit","matrix","matrix-chat","matrix-server","rocksdb","rust","server","uwu"],"latest_commit_sha":null,"homepage":"","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/matrix-construct.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-02-21T17:56:00.000Z","updated_at":"2025-09-29T10:46:25.000Z","dependencies_parsed_at":"2025-02-22T21:29:43.303Z","dependency_job_id":"78915962-623f-44d1-a613-05f4346d8605","html_url":"https://github.com/matrix-construct/tuwunel","commit_stats":null,"previous_names":["matrix-construct/tuwunel"],"tags_count":26,"template":false,"template_full_name":null,"purl":"pkg:github/matrix-construct/tuwunel","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/matrix-construct%2Ftuwunel","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/matrix-construct%2Ftuwunel/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/matrix-construct%2Ftuwunel/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/matrix-construct%2Ftuwunel/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/matrix-construct","download_url":"https://codeload.github.com/matrix-construct/tuwunel/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/matrix-construct%2Ftuwunel/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":278679347,"owners_count":26027054,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-06T02:00:05.630Z","response_time":65,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["chat","conduit","conduwuit","matrix","matrix-chat","matrix-server","rocksdb","rust","server","uwu"],"created_at":"2025-10-06T21:01:23.555Z","updated_at":"2026-03-08T01:31:09.934Z","avatar_url":"https://github.com/matrix-construct.png","language":"Rust","funding_links":[],"categories":["Rust"],"sub_categories":[],"readme":"# Tuwunel\u003csup\u003e💕\u003c/sup\u003e\n\n![GitHub License](https://img.shields.io/github/license/matrix-construct/tuwunel?style=flat%2Dsquare\u0026color=%238A2BE2)\n![GitHub Created At](https://img.shields.io/github/created-at/matrix-construct/tuwunel?style=flat%2Dsquare\u0026color=%238A2BE2)\n![GitHub Commit Activity](https://img.shields.io/github/commit-activity/m/matrix-construct/tuwunel?style=flat%2Dsquare\u0026link=https%3A%2F%2Fgithub.com%2Fmatrix-construct%2Ftuwunel%2Fpulse%2Fmonthly\u0026color=%238A2BE2)\n![Docker Pulls](https://img.shields.io/docker/pulls/jevolk/tuwunel?style=flat%2Dsquare\u0026color=8A2BE2)\n![GitHub Repo Stars](https://img.shields.io/github/stars/matrix-construct/tuwunel?style=flat%2Dsquare\u0026link=https%3A%2F%2Fgithub.com%2Fmatrix-construct%2Ftuwunel\u0026color=%238A2BE2)\n[![CI/CD](https://github.com/matrix-construct/tuwunel/actions/workflows/main.yml/badge.svg?branch=main\u0026style=flat%2Dsquare)](https://github.com/matrix-construct/tuwunel/actions/workflows/main.yml)\n\n\u003c!-- ANCHOR: catchphrase --\u003e\n\n## High Performance Matrix Homeserver in Rust!\n\n\u003c!-- ANCHOR_END: catchphrase --\u003e\n\n\u003c!-- ANCHOR: body --\u003e\n\n[![Documentation](https://img.shields.io/badge/documentation%2D_?color=%238A2BE2\u0026style=for-the-badge\u0026logo=mdBook\u0026logoColor=FFFFFF)](https://matrix-construct.github.io/tuwunel/)\n[![Demo Server](https://img.shields.io/badge/demo%20server%2D_?color=%238A2BE2\u0026style=for-the-badge\u0026logo=Element\u0026logoColor=FFFFFF)](https://try.tuwunel.chat)\n[![Support Chat](https://img.shields.io/matrix/tuwunel%3Amatrix.org.svg?color=098A09\u0026style=for-the-badge\u0026label=Support%20Chat\u0026labelColor=8A2BE2\u0026logo=Matrix)](https://matrix.to/#/#tuwunel:grin.hu)\n\nTuwunel is a featureful [Matrix](https://matrix.org/) homeserver you can use instead of Synapse\nwith your favorite [client](https://matrix.org/ecosystem/clients/),\n[bridge](https://matrix.org/ecosystem/bridges/) or\n[bot](https://matrix.org/ecosystem/integrations/). It is written entirely in Rust to be a scalable,\nlow-cost, enterprise-ready, community-driven alternative, fully implementing the\n[Matrix Specification](https://spec.matrix.org/latest/) for all but the most niche uses.\n\nThis project is the official successor to [conduwuit](https://github.com/x86pup/conduwuit) after it\nreached stability. Tuwunel is now used by many companies with a vested interest in its continued\ndevelopment by full-time staff. It is primarily sponsored by the government of\nSwitzerland 🇨🇭 where it is currently deployed for citizens.\n\n### Getting Started\n\n- [GitHub Releases](https://github.com/matrix-construct/tuwunel/releases)\n- [Sourcecode](https://github.com/matrix-construct/tuwunel/) `git clone https://github.com/matrix-construct/tuwunel.git`\n- [DockerHub](https://hub.docker.com/r/jevolk/tuwunel) or `docker pull jevolk/tuwunel:latest`\n- [GHCR](https://github.com/matrix-construct/tuwunel/pkgs/container/tuwunel) or `docker pull ghcr.io/matrix-construct/tuwunel:latest`\n- Static binaries available as [releases](https://github.com/matrix-construct/tuwunel/releases) or [build artifacts](https://github.com/matrix-construct/tuwunel/actions?query=branch%3Amain).\n- Deb and RPM packages available as [releases](https://github.com/matrix-construct/tuwunel/releases) or [build artifacts](https://github.com/matrix-construct/tuwunel/actions?query=branch%3Amain).\n- Arch package available as [tuwunel](https://aur.archlinux.org/packages/tuwunel) or [tuwunel-git](https://aur.archlinux.org/packages/tuwunel-git).\n- Nix package available as [`matrix-tuwunel`](https://search.nixos.org/packages?query=matrix-tuwunel) and NixOS module available as [`services.matrix-tuwunel`](https://search.nixos.org/options?query=services.matrix-tuwunel).\n- Alpine package available as [tuwunel](https://pkgs.alpinelinux.org/package/edge/testing/x86_64/tuwunel).\n\n**1.** [Configure](https://matrix-construct.github.io/tuwunel/configuration.html) by\ncopying and editing the `tuwunel-example.toml`. The `server_name` and `database_path` must be\nconfigured. **Most users deploy via docker or a distribution package and should follow the\n[appropriate guide](https://matrix-construct.github.io/tuwunel/deploying.html) instead.**\nThis is just a summary for the impatient. See the full\n[documentation](https://matrix-construct.github.io/tuwunel/).\n\n\u003e [!TIP]\n\u003e Avoid using a sub-domain for your `server_name`. You can always delegate later with a [`.well-known`](https://matrix-construct.github.io/tuwunel/deploying/root-domain-delegation.html)\n\u003e file, but you can never change your `server_name`.\n\n**2.** Setup TLS certificates. Most users enjoy the [Caddy](https://caddyserver.com/) reverse-proxy\nwhich automates their certificate renewal. Advanced users can load their own TLS certificates\nusing the configuration and Tuwunel can be deployed without a reverse proxy. Example\n`/etc/caddy/Caddyfile` configuration with [Element](https://github.com/element-hq/element-web/releases)\nunzipped to `/var/www/element`:\n```\ntuwunel.me, tuwunel.me:8448 {\n    reverse_proxy localhost:8008\n}\nweb.tuwunel.me {\n    root * /var/www/element/\n    file_server\n}\n```\n`caddy reload --config /etc/caddy/Caddyfile`\n\n**3.** Start the server, connect your client and register your username. The first registration is\ngranted server admin.\n\n\u003e [!TIP]\n\u003e Configure a secret `registration_token` and set `allow_registration = true`\n\n 🤗 Did you find this and other documentation helpful? We would love to hear feedback about setting\n up Tuwunel.\n\n\n### Migrating to Tuwunel\n\n| Can I migrate from | |\n|-----------------|-----------|\n| conduwuit? | ✅ Yes. This will be supported at a minimum for one year, but likely indefinitely. |\n| Synapse? | ❌ Not yet, but this is planned and an important issue. Subscribe to [#2](https://github.com/matrix-construct/tuwunel/issues/2). |\n| Conduit? | ❌ Not right now, but this is planned for the near future. Subscribe to [#41](https://github.com/matrix-construct/tuwunel/issues/41). |\n| Any other fork of Conduit? | ❌ No. The migration must be explicitly listed in this table. |\n\u003e [!CAUTION]\n\u003e **Never switch between different forks of Conduit or you will corrupt your database.**\n\u003e All derivatives of Conduit share the same linear database version without any awareness of other\n\u003e forks. The database will permanently corrupt and we will not be able to help you.\n\n#### Migrating from conduwuit\n\nMigrating from conduwuit to Tuwunel _just works_. In technical parlance it is a \"binary swap.\"\nAll you have to do is update to the latest Tuwunel and change the path to the executable from\n`conduwuit` to `tuwunel`.\n\nAnything else named \"conduwuit\" is still recognized, this includes environment variables with prefixes\nsuch as `CONDUWUIT_`. In fact, `CONDUIT_` is still recognized for our legacy users. You may have\nnoticed that various configs, yamls, services, users, and other items were renamed, but if you\nwere a conduwuit user we recommend against changing anything at all. This will keep things simple.\nIf you are not sure please ask. If you found out that something did in fact need to be changed\nplease open an issue immediately.\n\n\n### Upgrading \u0026 Downgrading Tuwunel\n\nWe strive to make moving between versions of Tuwunel safe and easy. Downgrading Tuwunel is always\nsafe but often prevented by a guard. An error will indicate the downgrade is not possible and a\nnewer version which does not error must be sought.\n\n#### Branches\n\nThe main branch is always _reasonably safe_ to run. We understand the propensity for users to simply clone\nthe main branch to get up and running, and we're obliged to ensure it's always viable. Nevertheless, only\ntagged releases are true releases.\n\n#### Container Tracking\n\n\u003e [!IMPORTANT]\n\u003e **We strongly advise tracking the `:latest` tag when automatically updating.**\n\nTracking `:latest` gives us the necessary discretion to keep you on the appropriate stable version.\nWe discourage tracking the main branch unless frequent restarts are acceptable. Alternatively,\ntracking the `:preview` tag provides the latest release-candidate becoming equivalent to `:latest`\nafter a release. Tracking the `:preview` tag is a worthy alternative to the main branch, with\nturbulence limited to release-time.\n\n### Getting Help \u0026 Support\n\nIf you are opposed to using github, or if private discussion is required such as for security\ndisclosures, or for any other reason, I would be happy to receive your DM at\n[@jason:tuwunel.me](https://matrix.to/#/@jason:tuwunel.me). This will not be bothering me as it would\nbe my pleasure to help you when possible. As an emergency contact you can send an email to\njasonzemos@gmail.com.\n\n##### Tuwunel Fanclub\n\nWe have an unofficial community-run chat which is publicly accessible at\n[#tuwunel:matrix.org](https://matrix.to/#/#tuwunel:matrix.org). The members, content, or moderation\ndecisions of this room are not in any way related or endorsed by this project or its sponsors,\nand not all project staff will be present there. There will be at least some presence by staff to\noffer assistance so long as the room remains in minimally good standing.\n\n\n## Tuwunel\u003csup\u003e💕\u003c/sup\u003e\n\nTuwunel's theme is **empathy** in communication defined by the works of\n[Edith Stein](https://plato.stanford.edu/entries/stein/). Empathy is the basis for how we approach\nevery message and our responsibility to the other in every conversation.\n\n\u003c!-- ANCHOR_END: body --\u003e\n\n\u003c!-- ANCHOR: footer --\u003e\n\n\u003c!-- ANCHOR_END: footer --\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmatrix-construct%2Ftuwunel","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmatrix-construct%2Ftuwunel","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmatrix-construct%2Ftuwunel/lists"}