jimzah/conduit
1
0
Fork 0
mirror of https://gitlab.com/famedly/conduit.git synced 2024-11-30 13:12:29 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
522 Commits 49 Branches 8 Tags 7.3 MiB
Rust 97.4%
Nix 0.9%
Python 0.7%
Shell 0.6%
Dockerfile 0.4%
7bc58461cd
Go to file
Timo Kösters 7bc58461cd
fix: avoid illegal instruction crash 
see https://github.com/spacejam/sled/issues/1232
2021-03-12 16:22:35 +01:00
.gitea Change license to Apache-2.0 2020-10-18 13:47:52 +02:00
.gitlab/issue_templates Chore: Add Issue Template 2021-02-26 14:55:06 +00:00
debian Lock down the Conduit process in the systemd unit 2020-11-24 14:42:20 +01:00
docker Fix order of docker command arguments and change repository link to... 2020-10-18 23:06:08 +02:00
src Merge branch 'incoming-pdu' into 'master' 2021-03-04 14:38:07 +00:00
tests Fix Complement CI paths 2021-03-04 17:22:23 +00:00
.dockerignore
.gitignore improvement: better default config 2021-01-01 11:24:09 +01:00
Cargo.lock chore: bump other dependencies to make it work 2021-03-04 12:29:08 +01:00
Cargo.toml fix: avoid illegal instruction crash 2021-03-12 16:22:35 +01:00
conduit-example.toml feat: opentelemetry/jaeger support 2021-03-02 15:08:54 +01:00
CROSS_COMPILE.md
DEPLOY.md fix: update binary file name in docs for consistency 2021-01-11 20:28:47 +01:00
docker-compose.yml
Dockerfile Fix order of docker command arguments and change repository link to... 2020-10-18 23:06:08 +02:00
LICENSE Change license to Apache-2.0 2020-10-18 13:47:52 +02:00
README.md docs: add icon and license to readme 2021-03-04 21:37:24 +01:00
rust-toolchain
rustfmt.toml

README.md

Conduit

A Matrix homeserver written in Rust

What is the goal?

A fast 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! Just open a Matrix client (https://app.element.io or Element Android for example) and register on the https://conduit.koesters.xyz homeserver.

What is it build on?

  • Ruma: Useful structures for endpoint requests and responses that can be (de)serialized
  • Sled: A simple (key, value) database with good performance
  • Rocket: A flexible web framework

What are the biggest things still missing?

  • Most federation features (invites, e2ee)
  • Push notifications on mobile
  • Notification settings
  • Lots of testing

Check out the Conduit 1.0 Release Milestone.

How can I deploy my own?

Deploy

Download or compile a Conduit binary, set up the config and call it from somewhere like a systemd script. Read more

Deploy using Docker

Pull and run the docker image with

docker pull matrixconduit/matrix-conduit:latest
docker run -d -p 8448:8000 -v db:/srv/conduit/.local/share/conduit matrixconduit/matrix-conduit:latest

Or build and run it with docker or docker-compose. Read more

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:nordgedanken.dev)
  3. Fork the repo and work on the issue. #conduit:nordgedanken.dev is happy to help :)
  4. Submit a MR

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