jimzah/conduit
1
0
Fork 0
mirror of https://gitlab.com/famedly/conduit.git synced 2024-11-30 05:02:31 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
2,160 Commits 49 Branches 8 Tags 7.3 MiB
Rust 97.4%
Nix 0.9%
Python 0.7%
Shell 0.6%
Dockerfile 0.4%
3dd21456ef
Go to file
Charles Hall 3dd21456ef
reduce scope of nixos documentation 
There are so many ways to do this we realistically shouldn't bother
describing any of them, especially because people should be learning all
the options and choosing the one that suits them best anyway.
2024-03-21 15:52:54 -07: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: build docs using mdBook 2024-03-16 20:01:15 -07: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 docs: build docs using mdBook 2024-03-16 20:01:15 -07:00
docker docs: build docs using mdBook 2024-03-16 20:01:15 -07:00
docs reduce scope of nixos documentation 2024-03-21 15:52:54 -07:00
src refactor: check if federation is disabled inside the authcheck where possible 2024-03-18 09:24:37 +00: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
.editorconfig chore: add EditorConfig 2024-03-16 20:01:16 -07:00
.envrc add script to build and push to binary cache 2024-01-25 11:34:46 -08:00
.gitignore docs: build docs using mdBook 2024-03-16 20:01:15 -07:00
.gitlab-ci.yml build book in ci, deploy it to gitlab pages 2024-03-16 20:01:15 -07:00
book.toml docs: build docs using mdBook 2024-03-16 20:01:15 -07: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 document log config syntax, don't give example 2024-03-10 22:53:27 -07:00
default.nix feat: support non-flake users 2024-02-01 19:19:56 -08:00
engage.toml build book in ci, deploy it to gitlab pages 2024-03-16 20:01:15 -07:00
flake.lock update flake.lock 2024-03-05 15:06:51 -08:00
flake.nix add mdbook to the devshell 2024-03-21 15:40:19 -07:00
LICENSE Change license to Apache-2.0 2020-10-18 13:47:52 +02:00
README.md docs: point people to the matrix client list instead of element 2024-03-17 19:21:29 +00: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

README.md

Conduit

A Matrix homeserver written in Rust

Please visit the Conduit documentation for more information. Alternatively you can open docs/introduction.md in this repository.

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 client that supports registration tokens such as Element web, Nheko or SchildiChat web and registering on the conduit.rs homeserver. The registration token is "for_testing_only". Don't share personal information. Once you have registered, you can use any other Matrix client to login.

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