2020-04-09 15:39:45 +00:00
|
|
|
# Conduit
|
|
|
|
|
### A Matrix homeserver written in Rust
|
2020-04-03 15:53:06 +00:00
|
|
|
|
2020-04-10 05:53:20 +00:00
|
|
|
[](https://liberapay.com/timokoesters)
|
2020-10-18 14:40:02 +00:00
|
|
|
[](https://matrix.to/#/#conduit:matrix.org)
|
2020-04-08 20:28:03 +00:00
|
|
|
|
2020-08-12 19:17:53 +00:00
|
|
|
#### What is the goal?
|
2020-05-29 07:54:30 +00:00
|
|
|
|
2020-10-18 11:23:06 +00:00
|
|
|
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.
|
2020-05-21 15:36:07 +00:00
|
|
|
|
2020-05-29 07:54:30 +00:00
|
|
|
#### Can I try it out?
|
2020-04-03 15:53:06 +00:00
|
|
|
|
2020-10-18 11:23:06 +00:00
|
|
|
Yes! Just open a Matrix client (<https://app.element.io> or Element Android for
|
|
|
|
|
example) and register on the `https://conduit.koesters.xyz` homeserver.
|
2020-05-29 07:54:30 +00:00
|
|
|
|
|
|
|
|
#### How can I deploy my own?
|
|
|
|
|
|
2020-08-12 19:17:53 +00:00
|
|
|
##### From source
|
2020-04-03 15:53:06 +00:00
|
|
|
|
2020-08-12 19:17:53 +00:00
|
|
|
Clone the repo, build it with `cargo build --release` and call the binary
|
2020-10-18 11:23:06 +00:00
|
|
|
(target/release/conduit) from somewhere like a systemd script. [Read
|
|
|
|
|
more](DEPLOY_FROM_SOURCE.md)
|
2020-08-12 19:17:53 +00:00
|
|
|
|
|
|
|
|
##### Using Docker
|
|
|
|
|
|
2020-08-24 21:30:39 +00:00
|
|
|
Pull and run the docker image with
|
|
|
|
|
|
|
|
|
|
``` bash
|
|
|
|
|
docker pull matrixconduit/matrix-conduit:latest
|
2020-10-18 21:06:08 +00:00
|
|
|
docker run -d -p 8448:8000 -v db:/srv/conduit/.local/share/conduit matrixconduit/matrix-conduit:latest
|
2020-08-24 21:30:39 +00:00
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Or build and run it with docker or docker-compose. [Read more](docker/README.md)
|
2020-08-04 20:06:13 +00:00
|
|
|
|
2020-04-03 15:53:06 +00:00
|
|
|
#### What is it build on?
|
|
|
|
|
|
2020-10-18 11:23:06 +00:00
|
|
|
- [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
|
2020-04-03 15:53:06 +00:00
|
|
|
- [Rocket](https://rocket.rs): A flexible web framework
|
|
|
|
|
|
2020-05-29 07:54:30 +00:00
|
|
|
#### What are the biggest things still missing?
|
|
|
|
|
|
2020-07-11 07:51:58 +00:00
|
|
|
- Appservices (Bridges and Bots)
|
2020-10-18 11:23:06 +00:00
|
|
|
- Most federation features (invites, e2ee)
|
2020-07-11 07:51:58 +00:00
|
|
|
- Push notifications on mobile
|
|
|
|
|
- Notification settings
|
2020-05-29 07:54:30 +00:00
|
|
|
- Lots of testing
|
2020-04-08 20:28:03 +00:00
|
|
|
|
2020-05-29 08:04:19 +00:00
|
|
|
Also check out the [milestones](https://git.koesters.xyz/timo/conduit/milestones).
|
|
|
|
|
|
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
|
|
|
|
|
#conduit:matrix.org)
|
2020-07-11 07:51:58 +00:00
|
|
|
3. Fork the repo and work on the issue. #conduit:matrix.org is happy to help :)
|
|
|
|
|
4. Submit a PR
|
2020-04-12 20:29:48 +00:00
|
|
|
|
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`
|
