Fork of Conduit Rust matrix homeserver
 
 
 
 
Go to file
Timo Kösters 7cd7f1923f
chore: update dependencies
2021-09-01 22:31:25 +02: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 Merge branch 'master' into 'master' 2021-09-01 16:04:41 +00:00
src revert Arc<EventId> commit 2021-09-01 22:30:11 +02: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 Use `$CI_COMMIT_SHORT_SHA` for `GIT_REF` 2021-08-31 18:03:44 +02:00
APPSERVICES.md docs: APPSERVICES setup guide 2021-05-22 13:55:28 +02:00
CROSS_COMPILE.md Merge branch 'tls-name' into 'master' 2021-04-23 05:22:07 +00:00
Cargo.lock chore: update dependencies 2021-09-01 22:31:25 +02:00
Cargo.toml chore: update dependencies 2021-09-01 22:31:25 +02:00
DEPLOY.md docs: update readme and version 2021-09-01 22:18:19 +02: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: update readme and version 2021-09-01 22:18: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:

  • Database stability (currently you might have to do manual upgrades or even wipe the db for new versions)
  • Edge cases for end-to-end encryption over federation
  • Typing and presence over federation
  • Lots of testing

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?

  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:nordgedanken.dev)
  3. Fork the repo and work on the issue. #conduit:nordgedanken.dev is happy to help :)
  4. Submit a MR

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