TudbuT/conduit
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
Conduit is a simple, fast and reliable chat server powered by Matrix https://conduit.rs
2138 commits 50 branches 7 tags 14 MiB
Rust 97.3%
Nix 0.9%
Python 0.8%
Shell 0.6%
Dockerfile 0.4%
Find a file
Charles Hall 741ca63e94 Merge branch 'argparse' into 'next' 
Add argument parser for the conduit executable

Closes #285

See merge request famedly/conduit!385
2024-03-11 18:03:39 +00: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 Merge branch 'ci-revamp-2022-10' into 'next' 2022-11-02 16:47:48 +00:00
.vscode The procMacro option has long been on by default 2022-12-16 10:12:11 +01:00
bin allow overriding the attic endpoint 2024-03-05 15:06:52 -08:00
complement make a bunch of changes so complement works again 2024-01-27 18:09:43 -08:00
debian feat: version checker 2023-07-29 21:53:57 +02:00
docker Update README.md to fix typo & fix compatibility with new versions of docker compose 2023-08-27 02:14:03 +00:00
nix only listen on IPv6 since that's what conduit does 2023-07-21 12:12:37 -07:00
src Add argument parser for the conduit executable 2024-03-11 09:43:02 -07:00
tests Complement improvements 2022-10-17 18:41:45 +02:00
.dockerignore fix(ci): Only build in (remote host) docker and switch to glibc 2022-11-02 12:12:48 +01:00
.envrc add script to build and push to binary cache 2024-01-25 11:34:46 -08:00
.gitignore use nix and engage to manage ci 2024-01-24 07:22:37 -08:00
.gitlab-ci.yml fix(ci): avoid duplicate pipelines 2024-03-11 12:43:49 +01:00
APPSERVICES.md Pre-0.3 doc adjustments 2022-02-04 18:05:24 +01:00
Cargo.lock switch/update rocksdb crate 2024-03-10 20:58:01 -07:00
Cargo.toml rename the rust-rocksdb crate to just rocksdb 2024-03-10 23:40:11 -07:00
CODE_OF_CONDUCT.md Add Contributor's Covenant Code of Conduct 2023-01-08 02:44:25 -05:00
conduit-example.toml feat: version checker 2023-07-29 21:53:57 +02:00
default.nix feat: support non-flake users 2024-02-01 19:19:56 -08:00
DEPLOY.md use nix-built binary to produce debian package 2024-03-05 15:06:52 -08:00
engage.toml add an engage file 2024-01-24 07:22:37 -08:00
flake.lock update flake.lock 2024-03-05 15:06:51 -08:00
flake.nix switch/update rocksdb crate 2024-03-10 20:58:01 -07:00
LICENSE Change license to Apache-2.0 2020-10-18 13:47:52 +02:00
README.md docs: small fixes for the README 2024-03-03 15:56:03 +01:00
rust-toolchain.toml update rust toolchain 2024-01-25 21:44:40 -08:00
rustfmt.toml chore: get rid of warnings 2021-03-18 18:33:43 +01:00
TURN.md Move appservice howto into whats-next; again, rename placeholder TURN url 2022-02-04 21:11:50 +01:00

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