2020-04-09 08:39:45 -07:00
|
|
|
# Conduit
|
|
|
|
|
### A Matrix homeserver written in Rust
|
2020-04-03 08:53:06 -07:00
|
|
|
|
2020-08-12 12:17:53 -07:00
|
|
|
#### What is the goal?
|
2020-05-29 00:54:30 -07:00
|
|
|
|
2020-10-18 04:23:06 -07: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 08:36:07 -07:00
|
|
|
|
2021-03-04 07:28:28 -07:00
|
|
|
|
2020-05-29 00:54:30 -07:00
|
|
|
#### Can I try it out?
|
2020-04-03 08:53:06 -07:00
|
|
|
|
2020-10-18 04:23:06 -07: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 00:54:30 -07:00
|
|
|
|
2021-03-04 07:28:28 -07:00
|
|
|
|
|
|
|
|
#### 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?
|
|
|
|
|
|
|
|
|
|
- Most federation features (invites, e2ee)
|
|
|
|
|
- Push notifications on mobile
|
|
|
|
|
- Notification settings
|
|
|
|
|
- Lots of testing
|
|
|
|
|
|
|
|
|
|
Check out the [Conduit 1.0 Release Milestone](https://gitlab.com/famedly/conduit/-/milestones/3).
|
|
|
|
|
|
|
|
|
|
|
2020-05-29 00:54:30 -07:00
|
|
|
#### How can I deploy my own?
|
|
|
|
|
|
2020-10-20 05:18:20 -07:00
|
|
|
##### Deploy
|
2020-04-03 08:53:06 -07:00
|
|
|
|
2021-03-04 07:28:28 -07:00
|
|
|
Download or compile a Conduit binary, set up the config and call it from somewhere like a systemd script. [Read
|
2020-10-20 05:18:20 -07:00
|
|
|
more](DEPLOY.md)
|
2020-08-12 12:17:53 -07:00
|
|
|
|
2020-10-20 05:18:20 -07:00
|
|
|
##### Deploy using Docker
|
2020-08-12 12:17:53 -07:00
|
|
|
|
2020-08-24 14:30:39 -07:00
|
|
|
Pull and run the docker image with
|
|
|
|
|
|
|
|
|
|
``` bash
|
|
|
|
|
docker pull matrixconduit/matrix-conduit:latest
|
2020-10-18 14:06:08 -07:00
|
|
|
docker run -d -p 8448:8000 -v db:/srv/conduit/.local/share/conduit matrixconduit/matrix-conduit:latest
|
2020-08-24 14:30:39 -07:00
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Or build and run it with docker or docker-compose. [Read more](docker/README.md)
|
2020-08-04 13:06:13 -07:00
|
|
|
|
2020-05-29 01:04:19 -07:00
|
|
|
|
2020-04-12 13:29:48 -07:00
|
|
|
#### How can I contribute?
|
|
|
|
|
|
2020-10-18 04:23:06 -07: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 07:28:28 -07: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 13:29:48 -07:00
|
|
|
|
2020-04-08 13:28:03 -07:00
|
|
|
#### Donate
|
|
|
|
|
|
2020-06-15 23:43:46 -07:00
|
|
|
Liberapay: <https://liberapay.com/timokoesters/>\
|
2020-06-15 23:21:06 -07:00
|
|
|
Bitcoin: `bc1qnnykf986tw49ur7wx9rpw2tevpsztvar5x8w4n`
|
2021-03-04 13:26:30 -07: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
|
