From 55842a0e57e215c3246660eae33cba2b844ab623 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Timo=20K=C3=B6sters?= Date: Fri, 29 May 2020 09:54:30 +0200 Subject: [PATCH] Update 'README.md' --- README.md | 39 +++++++++++++++++---------------------- 1 file changed, 17 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index 067d9ca1..947063b7 100644 --- a/README.md +++ b/README.md @@ -4,13 +4,22 @@ [![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) +#### 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: -#### What is the goal +#### Can I try it out? -A fast Matrix homeserver that's optimized for smaller, personal servers, instead of one server that has high scalability. +Yes! Just open and register on the default homeserver. You can also use and set the homeserver url to to connect. (BUG: Registration currently doesn't work on riot.im. [Fix](https://github.com/matrix-org/matrix-js-sdk/pull/1304) will come soon) + +#### 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](https://git.koesters.xyz/timo/conduit/wiki/Deploy). #### What is it build on? @@ -18,29 +27,15 @@ A fast Matrix homeserver that's optimized for smaller, personal servers, instead - [Sled](https://github.com/spacejam/sled): A simple (key, value) database with good performance - [Rocket](https://rocket.rs): A flexible web framework -#### What are the next steps? - -- [x] Register, login, authentication tokens -- [x] Create room messages -- [x] Sync room messages -- [x] Join rooms, lookup room ids -- [x] Riot web support -- [x] Room discovery -- [x] Read receipts -- [x] Typing indications -- [x] Invites, user search -- [x] Password hashing -- [x] Riot E2EE -- [x] Media -- [x] Permission system -- [ ] Basic federation -- [ ] State resolution -- [ ] Notifications (push rules) -- [ ] Riot presence +#### 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 #### How can I contribute? -The best way to find something to work on is by joining the #conduit:koesters.xyz Matrix room and asking. +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