char
/
conduit
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Merge pull request 'Update README.md' (#229) from update-readme into master 

Reviewed-on: https://git.koesters.xyz/timo/conduit/pulls/229
next
Timo Kösters 2020-10-18 13:35:01 +02:00
parent fbbf9f8999 ce94ad05a7
commit 9f487dd93a
1 changed files with 16 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
README.md
View File

@ -6,22 +6,22 @@
#### What is the goal? #### 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. 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,
#### Is it fast? friends or company.
See it in action: <https://www.youtube.com/watch?v=HoBslDtqC1k>
#### Can I try it out? #### 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. 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? #### How can I deploy my own?
##### From source ##### From source
Clone the repo, build it with `cargo build --release` and call the binary Clone the repo, build it with `cargo build --release` and call the binary
(target/release/conduit) from somewhere like a systemd script. [Read more](DEPLOY_FROM_SOURCE.md) (target/release/conduit) from somewhere like a systemd script. [Read
more](DEPLOY_FROM_SOURCE.md)
##### Using Docker ##### Using Docker
@ -36,14 +36,16 @@ Or build and run it with docker or docker-compose. [Read more](docker/README.md)
#### What is it build on? #### What is it build on?
- [Ruma](https://www.ruma.io): Useful structures for endpoint requests and responses that can be (de)serialized - [Ruma](https://www.ruma.io): Useful structures for endpoint requests and
- [Sled](https://github.com/spacejam/sled): A simple (key, value) database with good performance 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 - [Rocket](https://rocket.rs): A flexible web framework
#### What are the biggest things still missing? #### What are the biggest things still missing?
- Federation (Talk to other Matrix servers)
- Appservices (Bridges and Bots) - Appservices (Bridges and Bots)
- Most federation features (invites, e2ee)
- Push notifications on mobile - Push notifications on mobile
- Notification settings - Notification settings
- Lots of testing - Lots of testing
@ -52,8 +54,10 @@ Also check out the [milestones](https://git.koesters.xyz/timo/conduit/milestones
#### How can I contribute? #### 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 1. Look for an issue you would like to work on and make sure it's not assigned
2. Ask someone to assign the issue to you (comment on the issue or chat in #conduit:matrix.org) 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 :) 3. Fork the repo and work on the issue. #conduit:matrix.org is happy to help :)
4. Submit a PR 4. Submit a PR