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.
 
 
 
 
Charles Hall 10b7b174b6
fix documented target triple
2 years ago
.gitea Change license to Apache-2.0 5 years ago
.github/ISSUE_TEMPLATE Shorten more templates 5 years ago
.gitlab Merge branch 'ci-revamp-2022-10' into 'next' 3 years ago
.vscode The procMacro option has long been on by default 3 years ago
bin make a bunch of changes so complement works again 2 years ago
complement make a bunch of changes so complement works again 2 years ago
debian feat: version checker 3 years ago
docker Update README.md to fix typo & fix compatibility with new versions of docker compose 3 years ago
nix only listen on IPv6 since that's what conduit does 3 years ago
src typo: as -> has 2 years ago
tests Complement improvements 3 years ago
.dockerignore fix(ci): Only build in (remote host) docker and switch to glibc 3 years ago
.envrc add script to build and push to binary cache 2 years ago
.gitignore use nix and engage to manage ci 2 years ago
.gitlab-ci.yml feat(ci): push oci-image to docker hub 2 years ago
APPSERVICES.md Pre-0.3 doc adjustments 4 years ago
CODE_OF_CONDUCT.md Add Contributor's Covenant Code of Conduct 3 years ago
Cargo.lock revert: remove dependency on async_recursion 2 years ago
Cargo.toml revert: remove dependency on async_recursion 2 years ago
DEPLOY.md fix documented target triple 2 years ago
LICENSE Change license to Apache-2.0 5 years ago
README.md docs: small fixes for the README 2 years ago
TURN.md Move appservice howto into whats-next; again, rename placeholder TURN url 4 years ago
conduit-example.toml feat: version checker 3 years ago
default.nix feat: support non-flake users 2 years ago
engage.toml add an engage file 2 years ago
flake.lock update flake.lock 2 years ago
flake.nix update flake.lock 2 years ago
rust-toolchain.toml update rust toolchain 2 years ago
rustfmt.toml chore: get rid of warnings 5 years ago

README.md

Conduit

A Matrix homeserver written in Rust

What is Matrix?

Matrix is an open network for secure and decentralized communication. Users from every Matrix homeserver can chat with users from all other Matrix servers. You can even use bridges (also called Matrix appservices) to communicate with users outside of Matrix, like a community on Discord.

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. The registration token is "for_testing_only". Don't share personal information.

Server hosting for conduit.rs is donated by the Matrix.org Foundation.

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 emoji comparison over federation (E2EE chat works)
  • Outgoing read receipts, typing, presence over federation (incoming works)

How can I deploy my own?

If you want to connect an Appservice to Conduit, take a look at APPSERVICES.md.

How can I contribute?

  1. Look for an issue you would like to work on and make sure no one else is currently working on it.
  2. Tell us that you are working on the issue (comment on the issue or chat in #conduit:fachschaften.org). If it is more complicated, please explain your approach and ask questions.
  3. Fork the repo, create a new branch and push commits.
  4. Submit a MR

Contact

If you have any questions, feel free to

  • Ask in #conduit:fachschaften.org on Matrix
  • Write an E-Mail to conduit@koesters.xyz
  • Send an direct message to @timokoesters:fachschaften.org on Matrix
  • Open an issue on GitLab

Thanks to

Thanks to FUTO, Famedly, Prototype Fund (DLR and German BMBF) and all 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

Liberapay: https://liberapay.com/timokoesters/
Bitcoin: bc1qnnykf986tw49ur7wx9rpw2tevpsztvar5x8w4n

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