char
/
conduit
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
Fork of Conduit Rust matrix homeserver
196 Commits
1 Branch
0 Tags
2.6 MiB
Rust 97.2%
Python 1.2%
Dockerfile 1.1%
Shell 0.5%
 
 
 
 
Go to file
Timo Kösters b03d030b71 Merge pull request 'Improve README' (#145) from readme into master 
Reviewed-on: https://git.koesters.xyz/timo/conduit/pulls/145
 		2020-07-11 09:57:43 +02:00
.gitea Add liberapay, change pr template 2020-04-09 00:05:37 +02:00
src Add logout/all route to main 2020-07-05 15:35:03 -04:00
sytest Whitelist logout all 2020-07-07 23:09:29 -04:00
.gitignore fix: only allow valid usernames in /register 2020-05-13 12:25:15 +02:00
Cargo.lock chore: update dependencies 2020-06-26 18:04:08 +02:00
Cargo.toml improvement: upgrade to sled 0.32 2020-06-26 16:26:28 +02:00
LICENSE Add license 2020-04-08 22:28:03 +02:00
README.md Improve README 2020-07-11 09:55:44 +02:00
Rocket-example.toml fix: let example config show how to use registration_disabled 2020-06-08 14:29:44 +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 or RiotX for example) 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 (Talk to other Matrix servers)
  • Appservices (Bridges and Bots)
  • Push notifications on mobile
  • Notification settings
  • Lots of testing

Also check out the milestones.

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

Donate

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