2020-04-09 15:39:45 +00:00
|
|
|
# Conduit
|
|
|
|
### A Matrix homeserver written in Rust
|
2020-04-03 15:53:06 +00:00
|
|
|
|
2020-04-10 05:53:20 +00:00
|
|
|
[![Liberapay](https://img.shields.io/liberapay/receives/timokoesters?logo=liberapay)](https://liberapay.com/timokoesters)
|
|
|
|
[![Matrix](https://img.shields.io/matrix/conduit:koesters.xyz?server_fqdn=matrix.koesters.xyz&logo=matrix)](https://matrix.to/#/#conduit:koesters.xyz)
|
2020-04-08 20:28:03 +00:00
|
|
|
|
2020-04-12 20:29:48 +00:00
|
|
|
#### What is the goal
|
2020-04-03 15:53:06 +00:00
|
|
|
|
2020-04-12 20:29:48 +00:00
|
|
|
A fast Matrix homeserver that's optimized for smaller, personal servers, instead of one server that has high scalability.
|
2020-04-03 15:53:06 +00:00
|
|
|
|
|
|
|
#### What is it build on?
|
|
|
|
|
|
|
|
- [Ruma](https://www.ruma.io): Useful structures for endpoint requests and responses that can be (de)serialized
|
|
|
|
- [Sled](https://github.com/spacejam/sled): A simple (key, value) database with good performance
|
|
|
|
- [Rocket](https://rocket.rs): A flexible web framework
|
|
|
|
|
2020-04-12 20:29:48 +00:00
|
|
|
#### What are the next steps?
|
2020-04-03 15:53:06 +00:00
|
|
|
|
|
|
|
- [x] Register, login, authentication tokens
|
2020-04-06 17:57:04 +00:00
|
|
|
- [x] Create room messages
|
|
|
|
- [x] Sync room messages
|
2020-04-08 13:05:00 +00:00
|
|
|
- [x] Join rooms, lookup room ids
|
|
|
|
- [x] Basic Riot web support
|
2020-04-10 05:53:20 +00:00
|
|
|
- [x] Riot room discovery
|
2020-04-12 19:12:50 +00:00
|
|
|
- [x] Riot read receipts
|
|
|
|
- [x] Typing indications
|
2020-04-14 11:54:32 +00:00
|
|
|
- [x] Invites, user search
|
2020-04-08 13:05:00 +00:00
|
|
|
- [ ] Riot presence
|
2020-04-10 05:53:20 +00:00
|
|
|
- [ ] Password hashing
|
2020-04-08 13:05:00 +00:00
|
|
|
- [ ] Proper room creation
|
|
|
|
- [ ] Riot E2EE
|
|
|
|
- [ ] Basic federation
|
|
|
|
- [ ] State resolution
|
2020-04-08 20:28:03 +00:00
|
|
|
|
2020-04-12 20:29:48 +00:00
|
|
|
#### How can I contribute?
|
|
|
|
|
|
|
|
The best way to find something to work on is by joining the #conduit:koesters.xyz Matrix room and asking.
|
|
|
|
|
2020-04-08 20:28:03 +00:00
|
|
|
#### Donate
|
|
|
|
|
|
|
|
Liberapay: <https://liberapay.com/timokoesters/>
|