jackwagon/backend
1
0
Fork 0
Code Issues Pull requests Releases Activity
No description
1755 commits 46 branches 5 tags 5.1 MiB
Rust 97.6%
Dockerfile 0.9%
Python 0.8%
Shell 0.5%
Nix 0.2%
Find a file
Timo Kösters 3930fd08d7 Merge branch 'docs' into 'next' 
Update README

See merge request famedly/conduit!438
2022-12-18 06:06:26 +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
debian Lower log level commented config options 2022-10-13 13:11:15 +02:00
docker Describe a better way to enforce Content-Type in nginx 2022-11-08 15:56:24 +00:00
nix add nix/nixos deployment documentation 2022-10-16 10:50:52 -07:00
src fix: jaeger support 2022-12-18 06:37:03 +01:00
tests Lower default log level for docker 2022-10-13 13:11:15 +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 The procMacro option has long been on by default 2022-12-16 10:12:11 +01:00
.gitlab-ci.yml fix(ci): Only build in (remote host) docker and switch to glibc 2022-11-02 12:12:48 +01:00
APPSERVICES.md Pre-0.3 doc adjustments 2022-02-04 18:05:24 +01:00
Cargo.lock fix: jaeger support 2022-12-18 06:37:03 +01:00
Cargo.toml fix: jaeger support 2022-12-18 06:37:03 +01:00
conduit-example.toml Lower default log level 2022-10-13 13:11:13 +02:00
Cross.toml fix(ci): Fix musl builds 2022-03-08 21:52:57 +00:00
DEPLOY.md Update README 2022-12-18 07:02:07 +01:00
docker-compose.yml Lower default log level for docker and debian 2022-10-13 13:11:14 +02:00
Dockerfile fix(ci): Only build in (remote host) docker and switch to glibc 2022-11-02 12:12:48 +01:00
flake.lock add nix flake 2022-10-15 19:26:53 -07:00
flake.nix add nix flake 2022-10-15 19:26:53 -07:00
LICENSE Change license to Apache-2.0 2020-10-18 13:47:52 +02:00
README.md Update README 2022-12-18 07:02:07 +01: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.

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