Fork of Conduit Rust matrix homeserver

Go to file

Timo Kösters 178451e9b5 Merge branch 'deduplicate-watchers' into 'next' improvement: deduplicate watchers See merge request famedly/conduit!201		2021-09-14 07:10:59 +00: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	Fix deprecated/removed Traefik label	2021-09-03 21:51:17 +02:00
src	Merge branch 'deduplicate-watchers' into 'next'	2021-09-14 07:10:59 +00:00
tests	CI: Test registration with element web	2021-07-19 08:23:04 +00:00
.dockerignore	Update dockerignore	2020-09-17 20:14:07 +02:00
.gitignore	Sqlite	2021-07-14 07:07:08 +00:00
.gitlab-ci.yml	chore(CI): Adjust CI for master and next branch development model	2021-09-02 17:17:51 +02:00
APPSERVICES.md	Add mautrix-signal appservice instructions	2021-09-09 10:02:11 +02:00
CROSS_COMPILE.md	Merge branch 'tls-name' into 'master'	2021-04-23 05:22:07 +00:00
Cargo.lock	Upgrade ruma	2021-09-13 20:55:13 +02:00
Cargo.toml	Upgrade ruma	2021-09-13 20:55:13 +02:00
DEPLOY.md	These lines get generated by certbot. Having them in the file before running certbot results in an apache2 error, and putting them in afterwards is not necessary, since certbot places them there on its own.	2021-09-06 18:35:35 +00:00
Dockerfile	Move docker healthcheck into dedicated script.	2021-08-29 20:01:38 +02: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	registration default true	2021-08-31 18:25:35 +02:00
docker-compose.yml	registration default true	2021-08-31 18:25:35 +02:00
rust-toolchain	fix toolchain	2021-07-14 15:46:30 +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