Go to file
Timo Kösters de6c3312ce
docs: make all configs match
2022-02-16 15:11:46 +01:00
.gitea Change license to Apache-2.0 2020-10-18 13:47:52 +02:00
.github/ISSUE_TEMPLATE Shorten more templates 2021-07-18 20:43:21 +00:00
.gitlab Shorten more templates 2021-07-18 20:43:21 +00:00
.vscode add settings.json 2021-03-14 11:55:28 +01:00
cross Use prebuilt CI-containers from https://gitlab.com/jfowl/conduit-containers 2022-02-01 23:51:38 +00:00
debian docs: make all configs match 2022-02-16 15:11:46 +01:00
docker docs: make all configs match 2022-02-16 15:11:46 +01:00
src Change this to handler 2022-02-13 11:30:04 +00:00
tests Port from Rocket to axum 2022-02-12 12:56:07 +01:00
.dockerignore CI: New Multiarch builds and Docker images + cargo clippy/test output now integrated into GitLab 2021-11-21 17:34:08 +00:00
.gitignore Port from Rocket to axum 2022-02-12 12:56:07 +01:00
.gitlab-ci.yml feat(ci): Lint dockerfiles with hadolint 2022-02-15 20:01:38 +01:00
APPSERVICES.md Pre-0.3 doc adjustments 2022-02-04 18:05:24 +01:00
Cargo.lock take advantage of multiple paths 2022-02-13 12:07:00 +01:00
Cargo.toml take advantage of multiple paths 2022-02-13 12:07:00 +01:00
Cross.toml Use prebuilt CI-containers from https://gitlab.com/jfowl/conduit-containers 2022-02-01 23:51:38 +00:00
DEPLOY.md docs: make all configs match 2022-02-16 15:11:46 +01:00
Dockerfile docs: make all configs match 2022-02-16 15:11:46 +01:00
LICENSE Change license to Apache-2.0 2020-10-18 13:47:52 +02:00
README.md Port from Rocket to axum 2022-02-12 12:56:07 +01:00
TURN.md Move appservice howto into whats-next; again, rename placeholder TURN url 2022-02-04 21:11:50 +01:00
conduit-example.toml docs: make all configs match 2022-02-16 15:11:46 +01:00
docker-compose.yml docs: make all configs match 2022-02-16 15:11:46 +01:00
rustfmt.toml chore: get rid of warnings 2021-03-18 18:33:43 +01:00

README.md

Conduit

A Matrix homeserver written in Rust

What is the goal?

An efficient Matrix homeserver that's easy to set up and just works. You can install it on a mini-computer like the Raspberry Pi to host Matrix for your family, friends or company.

Can I try it out?

Yes! You can test our Conduit instance by opening a Matrix client (https://app.element.io or Element Android for example) and registering on the conduit.rs homeserver.

It is hosted on a ODROID HC 2 with 2GB RAM and a SAMSUNG Exynos 5422 CPU, which was used in the Samsung Galaxy S5. It joined many big rooms including Matrix HQ.

What is the current status?

As of 2021-09-01, Conduit is Beta, meaning you can join and participate in most Matrix rooms, but not all features are supported and you might run into bugs from time to time.

There are still a few important features missing:

  • E2EE verification over federation
  • Outgoing read receipts, typing, presence over federation

Check out the Conduit 1.0 Release Milestone.

How can I deploy my own?

If you want to connect an Appservice to Conduit, take a look at APPSERVICES.md.

How can I contribute?

  1. Look for an issue you would like to work on and make sure it's not assigned to other users
  2. Ask someone to assign the issue to you (comment on the issue or chat in #conduit:fachschaften.org)
  3. Fork the repo and work on the issue.#conduit:fachschaften.org is happy to help :)
  4. Submit a MR

Thanks to

Thanks to Famedly, Prototype Fund (DLR and German BMBF) and all other individuals for financially supporting this project.

Thanks to the contributors to Conduit and all libraries we use, for example:

  • Ruma: A clean library for the Matrix Spec in Rust
  • axum: A modular web framework

Donate

Liberapay: https://liberapay.com/timokoesters/
Bitcoin: bc1qnnykf986tw49ur7wx9rpw2tevpsztvar5x8w4n

Lightning Bolt Logo: https://github.com/mozilla/fxemoji/blob/gh-pages/svgs/nature/u26A1-bolt.svg
Logo License: https://github.com/mozilla/fxemoji/blob/gh-pages/LICENSE.md