You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
Jonas Zohren 70b6890edd
docs: Use mdbook for docs
4 years ago
.gitea Change license to Apache-2.0 5 years ago
.github/ISSUE_TEMPLATE Shorten more templates 5 years ago
.gitlab docs: Use mdbook for docs 4 years ago
.vscode feat: Provide sane defaults for vscode developing 4 years ago
debian Suggestions from Jonas Zohren 4 years ago
docker docs: Use mdbook for docs 4 years ago
docs docs: Use mdbook for docs 4 years ago
src fix: cors warning 4 years ago
tests Port from Rocket to axum 4 years ago
.dockerignore CI: New Multiarch builds and Docker images + cargo clippy/test output now integrated into GitLab 4 years ago
.gitignore docs: Use mdbook for docs 4 years ago
.gitlab-ci.yml docs: Use mdbook for docs 4 years ago
Cargo.lock bump ruma 4 years ago
Cargo.toml docs: Use mdbook for docs 4 years ago
Cross.toml fix(ci): Fix musl builds 4 years ago
Dockerfile fix(docker): use user 1000 and standard db path 4 years ago
LICENSE Change license to Apache-2.0 5 years ago
README.md docs: Use mdbook for docs 4 years ago
book.toml docs: Use mdbook for docs 4 years ago
conduit-example.toml docs: make all configs match 4 years ago
docker-compose.yml Suggestions from Jonas Zohren 4 years ago
rustfmt.toml chore: get rid of warnings 5 years ago

README.md

Conduit

An efficient Matrix homeserver written in Rust

🚀 Get started

You can find all the details on how to set up and manage your Conduit server in the Documentation

FAQ

What is the goal?

An efficient 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! 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.

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.

What is the current status?

Conduit is Beta, meaning you can join and participate in most Matrix rooms, but not all features are supported, and you might run into bugs from time to time.

There are still a few important features missing:

  • E2EE verification over federation
  • Outgoing read receipts, typing, presence over federation

Check out the Conduit 1.0 Release Milestone.

💻 How to contribute

  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:fachschaften.org)
  3. Fork the repo and work on the issue. #conduit:fachschaften.org is happy to help :)
  4. Submit a merge request

🤗 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
  • Axum: A modular web framework

💸 Donate

If you want to support the project, you can donate to Timo, the maintainer via Liberapay or Bitcoin (bc1qnnykf986tw49ur7wx9rpw2tevpsztvar5x8w4n)

The Conduit Lightning Bolt logo is courtesy of Mozilla FxEmojis (CC BY 4.0)