dolysis/conduwuit
3
0
Fork 0
mirror of https://github.com/girlbossceo/conduwuit.git synced 2024-11-25 22:48:34 +00:00
Code Issues Packages Projects Releases Wiki Activity
330 commits 23 branches 14 tags 15 MiB
Rust 95.5%
Nix 1.8%
CSS 1.5%
Shell 0.6%
Python 0.6%
Find a file
Valkum 8d66428beb Add intermediate container to hide ARGs 
ARGs contain secrets to speed up builds
2020-09-17 12:50:37 +02:00
.gitea Fix license. 2020-08-17 13:59:35 +02:00
docker Docker add healthcheck and mention Docker Hub image 2020-08-25 09:02:45 +02:00
src Fix /upgrade account data problems 2020-09-01 13:08:49 +02:00
tests Add intermediate container to hide ARGs 2020-09-17 12:50:37 +02:00
.dockerignore Initial docker files trinity 2020-08-11 15:38:23 +02:00
.gitignore fix: only allow valid usernames in /register 2020-05-13 12:25:15 +02:00
Cargo.lock improvement: add remaining key backup endpoints 2020-08-27 14:52:20 +02:00
Cargo.toml fix: set limited to true when skipping messages in /sync 2020-08-23 16:14:09 +02:00
DEPLOY_FROM_SOURCE.md Make default server name more obvious 2020-08-18 19:18:10 +02:00
docker-compose.yml Docker add healthcheck and mention Docker Hub image 2020-08-25 09:02:45 +02:00
Dockerfile Docker add healthcheck and mention Docker Hub image 2020-08-25 09:02:45 +02:00
LICENSE Add license 2020-04-08 22:28:03 +02:00
README.md Docker add healthcheck and mention Docker Hub image 2020-08-25 09:02:45 +02:00
Rocket-example.toml improvement: documentation 2020-07-27 18:06:36 +02:00
rust-toolchain improvement: switch to stable rust 2020-07-22 22:42:01 +02:00
rustfmt.toml Use sled::Tree::prefix_search for deviceids 2020-03-30 13:46:18 +02:00

README.md

Conduit

A Matrix homeserver written in Rust

Liberapay Matrix

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.

Is it fast?

See it in action: https://www.youtube.com/watch?v=HoBslDtqC1k

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.

How can I deploy my own?

From source

Clone the repo, build it with cargo build --release and call the binary (target/release/conduit) from somewhere like a systemd script. Read more

Using Docker

Pull and run the docker image with

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

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

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?

  • Federation (Talk to other Matrix servers)
  • Appservices (Bridges and Bots)
  • Push notifications on mobile
  • Notification settings
  • Lots of testing

Also check out the milestones.

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

Donate

Liberapay: https://liberapay.com/timokoesters/
Bitcoin: bc1qnnykf986tw49ur7wx9rpw2tevpsztvar5x8w4n