Fork of Conduit Rust matrix homeserver
 
 
 
 
Go to file
Timo Kösters 22a12ac6c0 Merge pull request 'Update 'README.md'' (#104) from riot-fixed into master 2020-06-05 09:31:23 +02:00
.gitea Add liberapay, change pr template 2020-04-09 00:05:37 +02:00
src feat: kick,ban,unban user route 2020-06-04 16:51:36 +02:00
sytest feat: kick,ban,unban user route 2020-06-04 16:51:36 +02:00
.gitignore fix: only allow valid usernames in /register 2020-05-13 12:25:15 +02:00
Cargo.lock feat: load replies, forward pagination 2020-06-04 13:58:55 +02:00
Cargo.toml feat: load replies, forward pagination 2020-06-04 13:58:55 +02:00
LICENSE Add license 2020-04-08 22:28:03 +02:00
README.md Update 'README.md' 2020-06-04 22:51:19 +02:00
Rocket-example.toml feat: room visibility and aliases 2020-05-31 09:46:11 +02:00
rust-toolchain refactor: make cargo clippy happier 2020-05-11 12:34:48 +02:00
rustfmt.toml Use sled::Tree::prefix_search for deviceids 2020-03-30 13:46:18 +02:00

README.md

Conduit

A Matrix homeserver written in Rust

Liberapay Matrix

What is the goal

A fast 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.

Is it fast?

See it in action: https://www.youtube.com/watch?v=HoBslDtqC1k

Can I try it out?

Yes! Just open Riot (https://riot.im/app) and register on the https://conduit.koesters.xyz:14004 homeserver.

How can I deploy my own?

You just have to clone the repo, build it with cargo build --release and call the binary (target/release/conduit) from somewhere like a systemd script. It's explained in more detail here.

What is it build on?

  • Ruma: Useful structures for endpoint requests and responses that can be (de)serialized
  • Sled: A simple (key, value) database with good performance
  • Rocket: A flexible web framework

What are the biggest things still missing?

  • Federation (Make Conduit talk to other Matrix servers)
  • Notifications (Make Matrix client notify the user when new messages or pings arrive)
  • Lots of testing

Also check out the milestones.

How can I contribute?

If you want to help, you may be able to find something in the issue tracker. If you do, comment on the issue, so others know. You can also join #conduit:matrix.org and ask there.

Donate

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