Matthias/conduit
1
0
Fork 0
Code Issues 179 Pull requests 44 Projects Releases 5 Packages Wiki Activity
Test to reproduce issue
1467 commits 44 branches 5 tags 6.5 MiB
Rust 97.4%
Python 0.8%
Nix 0.8%
Shell 0.6%
Dockerfile 0.4%
Find a file
Jonas Zohren 70b6890edd
docs: Use mdbook for docs
2022-04-09 12:56:16 +02:00
.gitea Change license to Apache-2.0 2020-10-18 13:47:52 +02:00
.github/ISSUE_TEMPLATE Shorten more templates 2021-07-18 20:43:21 +00:00
.gitlab docs: Use mdbook for docs 2022-04-09 12:56:16 +02:00
.vscode feat: Provide sane defaults for vscode developing 2022-02-17 11:14:50 +00:00
debian Suggestions from Jonas Zohren 2022-02-16 15:12:38 +01:00
docker docs: Use mdbook for docs 2022-04-09 12:56:16 +02:00
docs docs: Use mdbook for docs 2022-04-09 12:56:16 +02:00
src fix: cors warning 2022-04-07 17:09:07 +02:00
tests Port from Rocket to axum 2022-02-12 12:56:07 +01:00
.dockerignore CI: New Multiarch builds and Docker images + cargo clippy/test output now integrated into GitLab 2021-11-21 17:34:08 +00:00
.gitignore docs: Use mdbook for docs 2022-04-09 12:56:16 +02:00
.gitlab-ci.yml docs: Use mdbook for docs 2022-04-09 12:56:16 +02:00
book.toml docs: Use mdbook for docs 2022-04-09 12:56:16 +02:00
Cargo.lock bump ruma 2022-04-07 17:02:49 +02:00
Cargo.toml docs: Use mdbook for docs 2022-04-09 12:56:16 +02:00
conduit-example.toml docs: make all configs match 2022-02-16 15:11:46 +01:00
Cross.toml fix(ci): Fix musl builds 2022-03-08 21:52:57 +00:00
docker-compose.yml Suggestions from Jonas Zohren 2022-02-16 15:12:38 +01:00
Dockerfile fix(docker): use user 1000 and standard db path 2022-02-16 15:13:04 +01:00
LICENSE Change license to Apache-2.0 2020-10-18 13:47:52 +02:00
README.md docs: Use mdbook for docs 2022-04-09 12:56:16 +02:00
rustfmt.toml chore: get rid of warnings 2021-03-18 18:33:43 +01:00

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)