Skip to content
Snippets Groups Projects
Commit 55842a0e authored by Timo Kösters's avatar Timo Kösters
Browse files

Update 'README.md'

parent 25ebde5a
No related branches found
No related tags found
No related merge requests found
......@@ -4,13 +4,22 @@ ### A Matrix homeserver written in Rust
[![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: <https://www.youtube.com/watch?v=HoBslDtqC1k>
#### 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 <https://riot.conduit.rs> and register on the default homeserver. You can also use <https://riot.im/app> and set the homeserver url to <https://conduit.koesters.xyz:14004> 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 @@ #### What is it build on?
- [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
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment