conduit/README.md

74 lines
2.3 KiB
Markdown
Raw Normal View History

2020-04-09 15:39:45 +00:00
# Conduit
### A Matrix homeserver written in Rust
2020-04-03 15:53:06 +00:00
#### What is the goal?
2020-05-29 07:54:30 +00:00
2021-09-01 11:09:24 +00:00
An efficient Matrix homeserver that's easy to set up and just works. You can install
2020-10-18 11:23:06 +00:00
it on a mini-computer like the Raspberry Pi to host Matrix for your family,
friends or company.
2020-05-21 15:36:07 +00:00
2021-03-04 14:28:28 +00:00
2020-05-29 07:54:30 +00:00
#### Can I try it out?
2020-04-03 15:53:06 +00:00
2021-09-01 11:09:24 +00:00
Yes! You can test our Conduit instance by opening a Matrix client (<https://app.element.io> or Element Android for
example) and registering on the `conduit.rs` homeserver.
2020-05-29 07:54:30 +00:00
2021-09-01 11:09:24 +00:00
It is hosted on a ODROID HC 2 with 2GB RAM and a SAMSUNG Exynos 5422 CPU, which
was used in the Samsung Galaxy S5. It joined many big rooms including Matrix
HQ.
2021-03-04 14:28:28 +00:00
2021-04-20 10:53:20 +00:00
#### What is the current status?
2021-03-04 14:28:28 +00:00
2021-09-01 20:49:16 +00:00
As of 2021-09-01, Conduit is Beta, meaning you can join and participate in most
2021-09-01 11:09:24 +00:00
Matrix rooms, but not all features are supported and you might run into bugs
from time to time.
2021-04-20 10:53:20 +00:00
There are still a few important features missing:
2021-09-01 20:49:16 +00:00
- E2EE verification over federation
- Outgoing read receipts, typing, presence over federation
2021-03-04 14:28:28 +00:00
Check out the [Conduit 1.0 Release Milestone](https://gitlab.com/famedly/conduit/-/milestones/3).
2020-05-29 07:54:30 +00:00
#### How can I deploy my own?
2021-09-01 11:09:24 +00:00
Simple install (this was tested the most): [DEPLOY.md](DEPLOY.md)\
Debian package: [debian/README.Debian](debian/README.Debian)\
Docker: [docker/README.md](docker/README.md)
2021-09-01 11:09:24 +00:00
If you want to connect an Appservice to Conduit, take a look at [APPSERVICES.md](APPSERVICES.md).
2020-05-29 08:04:19 +00:00
2020-04-12 20:29:48 +00:00
#### How can I contribute?
2020-10-18 11:23:06 +00:00
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
2021-03-04 14:28:28 +00:00
#conduit:nordgedanken.dev)
3. Fork the repo and work on the issue. #conduit:nordgedanken.dev is happy to help :)
4. Submit a MR
2020-04-12 20:29:48 +00:00
2021-09-02 11:05:19 +00:00
#### Thanks to
Thanks to Famedly, Prototype Fund (DLR and German BMBF) and all other individuals for financially supporting this project.
Thanks to the contributors to Conduit and all libraries we use, for example:
- Ruma: A clean library for the Matrix Spec in Rust
- Rocket: A flexible web framework
2020-04-08 20:28:03 +00:00
#### Donate
2020-06-16 06:43:46 +00:00
Liberapay: <https://liberapay.com/timokoesters/>\
2020-06-16 06:21:06 +00:00
Bitcoin: `bc1qnnykf986tw49ur7wx9rpw2tevpsztvar5x8w4n`
2021-03-04 20:26:30 +00:00
#### Logo
Lightning Bolt Logo: https://github.com/mozilla/fxemoji/blob/gh-pages/svgs/nature/u26A1-bolt.svg \
Logo License: https://github.com/mozilla/fxemoji/blob/gh-pages/LICENSE.md