jimzah/conduit
1
0
Fork 0
mirror of https://gitlab.com/famedly/conduit.git synced 2024-11-26 19:22:29 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
2,026 Commits 49 Branches 8 Tags 7.3 MiB
Rust 97.4%
Nix 0.9%
Python 0.7%
Shell 0.6%
Dockerfile 0.4%
e8ac881b2f
Go to file
Charles Hall e8ac881b2f
add an engage file 
See <https://charles.page.computer.surgery/engage/> for info.
2024-01-24 07:22:37 -08:00
.gitea
.github/ISSUE_TEMPLATE
.gitlab
.vscode
complement
debian
docker Update README.md to fix typo & fix compatibility with new versions of docker compose 2023-08-27 02:14:03 +00:00
nix
src fix cargo doc lints 2024-01-24 07:22:37 -08:00
tests
.dockerignore
.envrc add shebang to .envrc 2023-12-23 22:21:19 -08:00
.gitignore
.gitlab-ci.yml
APPSERVICES.md
Cargo.lock comment out heed backend things 2024-01-18 12:27:48 -08:00
Cargo.toml comment out heed backend things 2024-01-18 12:27:48 -08:00
CODE_OF_CONDUCT.md
conduit-example.toml
DEPLOY.md
Dockerfile
engage.toml add an engage file 2024-01-24 07:22:37 -08:00
flake.lock
flake.nix add an engage file 2024-01-24 07:22:37 -08:00
LICENSE
README.md feat: registration tokens 2023-08-09 18:27:30 +02:00
rustfmt.toml
TURN.md

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)

Check out the Conduit 1.0 Release Milestone.

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 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 MR

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

Contact

If you run into any question, feel free to

  • Ask us 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

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