9c095f1538
Update 'README.md' Update README, fix CI Co-authored-by: timokoesters <timo@koesters.xyz> Reviewed-on: https://git.koesters.xyz/timo/conduit/pulls/148
50 lines
2 KiB
Markdown
50 lines
2 KiB
Markdown
# Conduit
|
|
### A Matrix homeserver written in Rust
|
|
|
|
[](https://liberapay.com/timokoesters)
|
|
[](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>
|
|
|
|
#### Can I try it out?
|
|
|
|
Yes! Just open a Matrix client (<https://app.element.io> or Element Android for example) and register on the `https://conduit.koesters.xyz` 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](https://git.koesters.xyz/timo/conduit/wiki/Deploy).
|
|
|
|
#### 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
|
|
|
|
#### 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](https://git.koesters.xyz/timo/conduit/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`
|