dolysis
/
conduwuit
mirror of https://github.com/girlbossceo/conduwuit.git
3
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
1,934 Commits 28 Branches 14 Tags 14 MiB
Rust 95.5%
Nix 1.8%
CSS 1.5%
Shell 0.6%
Python 0.6%
Go to file
Paul van Tilburg 433dad6ac2
Turn README.Debian into a markdown file 
It is common to have a markdown file per deployment subdirectory.
Still install it as `README.Debian` to `/usr/share/doc/matrix-conduit`
as per Debian policy.

Also update the link in the main `README.md` file.
 		2023-07-23 12:37:38 +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 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
complement add little readme 2023-01-26 18:28:33 +01:00
debian Turn README.Debian into a markdown file 2023-07-23 12:37:38 +02:00
docker Add a dynamic address resolution to the Docker healthcheck 2023-01-27 22:43:04 +00:00
nix only listen on IPv6 since that's what conduit does 2023-07-21 12:12:37 -07:00
src fix: e2ee over federation 2023-07-16 16:50:03 +02: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 nix flake 2022-10-15 19:26:53 -07:00
.gitignore Merge remote-tracking branch 'origin/next' into complement-improvements 2023-01-26 18:19:39 +01:00
.gitlab-ci.yml ci: Fix "0 B" image size display 2023-07-04 21:13:11 +00:00
APPSERVICES.md Pre-0.3 doc adjustments 2022-02-04 18:05:24 +01:00
CODE_OF_CONDUCT.md Add Contributor's Covenant Code of Conduct 2023-01-08 02:44:25 -05:00
Cargo.lock bump ruma 2023-07-10 16:24:57 +02:00
Cargo.toml Turn README.Debian into a markdown file 2023-07-23 12:37:38 +02:00
DEPLOY.md Replace nogroup with dedicated user group 2023-07-23 14:21:36 +08:00
Dockerfile chore(ci): Adjust to rust version bumps 2023-06-10 15:35:22 +00:00
LICENSE Change license to Apache-2.0 2020-10-18 13:47:52 +02:00
README.md Turn README.Debian into a markdown file 2023-07-23 12:37:38 +02:00
TURN.md Move appservice howto into whats-next; again, rename placeholder TURN url 2022-02-04 21:11:50 +01:00
conduit-example.toml document `trusted_servers` option 2023-01-09 08:14:13 -08:00
docker-compose.yml Lower default log level for docker and debian 2022-10-13 13:11:14 +02:00
flake.lock update flake.lock 2023-07-16 13:37:40 -07:00
flake.nix Revert "only use musl on x86_64" 2023-07-16 13:48:05 -07: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

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.

Registration is currently disabled because of scammers. For an account please message us (see contact section below).

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