e305889b72 | ||
---|---|---|
.gitea | ||
.gitlab/issue_templates | ||
debian | ||
docker | ||
src | ||
tests | ||
.dockerignore | ||
.gitignore | ||
CROSS_COMPILE.md | ||
Cargo.lock | ||
Cargo.toml | ||
DEPLOY.md | ||
Dockerfile | ||
LICENSE | ||
README.md | ||
conduit-example.toml | ||
docker-compose.yml | ||
rust-toolchain | ||
rustfmt.toml |
README.md
Conduit
A Matrix homeserver written in Rust
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.
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?
Deploy
Download or compile a conduit binary and call it from somewhere like a systemd script. Read more
Deploy using Docker
Pull and run the docker image with
docker pull matrixconduit/matrix-conduit:latest
docker run -d -p 8448:8000 -v db:/srv/conduit/.local/share/conduit matrixconduit/matrix-conduit:latest
Or build and run it with docker or docker-compose. Read more
What is it build on?
- Ruma: Useful structures for endpoint requests and responses that can be (de)serialized
- Sled: A simple (key, value) database with good performance
- Rocket: A flexible web framework
What are the biggest things still missing?
- Appservices (Bridges and Bots)
- Most federation features (invites, e2ee)
- Push notifications on mobile
- Notification settings
- Lots of testing
Also check out the milestones.
How can I contribute?
- Look for an issue you would like to work on and make sure it's not assigned to other users
- Ask someone to assign the issue to you (comment on the issue or chat in #conduit:matrix.org)
- Fork the repo and work on the issue. #conduit:matrix.org is happy to help :)
- Submit a PR
Donate
Liberapay: https://liberapay.com/timokoesters/
Bitcoin: bc1qnnykf986tw49ur7wx9rpw2tevpsztvar5x8w4n