Go to file

Timo Kösters 4f39d36e98 docs: lazy loading		2022-01-13 22:38:52 +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
debian	registration default true	2021-08-31 18:25:35 +02:00
docker	Make traefik+nginx config more self-contained	2022-01-07 13:06:21 +00:00
src	docs: lazy loading	2022-01-13 22:38:52 +01:00
tests	Add 'Federation publicRoom Name/topic keys are correct' test to sytest whitelist	2021-10-26 13:30:02 +00: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	Sqlite	2021-07-14 07:07:08 +00:00
.gitlab-ci.yml	CI: Use curl instead of wget	2021-12-14 11:16:40 +01:00
APPSERVICES.md	Add ability to remove an appservice	2021-12-20 15:46:36 +01:00
CROSS_COMPILE.md	Merge branch 'tls-name' into 'master'	2021-04-23 05:22:07 +00:00
Cargo.lock	improvement: allow rocksdb again	2022-01-13 22:10:43 +01:00
Cargo.toml	fix: atomic increment	2022-01-13 22:28:18 +01:00
DEPLOY.md	Fixes for !225	2021-11-25 22:36:44 +00:00
Dockerfile	Update docker images	2021-12-15 10:14:20 +00:00
LICENSE	Change license to Apache-2.0	2020-10-18 13:47:52 +02:00
README.md	docs: add thanks to	2021-09-02 13:05:19 +02:00
conduit-example.toml	Change listen address when running inside a Container to prevent Bad Gateway error	2021-09-23 07:49:52 +00:00
docker-compose.yml	registration default true	2021-08-31 18:25:35 +02:00
rust-toolchain	Upgrade Ruma	2021-10-13 10:16:45 +02: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?

Simple install (this was tested the most): DEPLOY.md
Debian package: debian/README.Debian
Docker: docker/README.md

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

How can I contribute?

Look for an issue you would like to work on and make sure it's not assigned to other users
Ask someone to assign the issue to you (comment on the issue or chat in #conduit:nordgedanken.dev)
Fork the repo and work on the issue. #conduit:nordgedanken.dev is happy to help :)
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
Rocket: A flexible web framework

Donate

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

Logo

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