dolysis/conduwuit
3
0
Fork 0
mirror of https://github.com/girlbossceo/conduwuit.git synced 2024-11-26 07:34:25 +00:00
Code Issues Packages Projects Releases Wiki Activity
289 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
Timo Kösters 4b3d6e736f Merge pull request 'Alpine based Docker image' (#152) from Weasy666/conduit:master into master 
Reviewed-on: https://git.koesters.xyz/timo/conduit/pulls/152
Reviewed-by: Timo Kösters <timo@koesters.xyz>
2020-08-12 21:42:58 +02:00
.gitea
docker docs: add documentation to the repo and improve layout 2020-08-12 21:17:53 +02:00
src
sytest
.dockerignore
.gitignore
Cargo.lock
Cargo.toml
DEPLOY_FROM_SOURCE.md docs: add documentation to the repo and improve layout 2020-08-12 21:17:53 +02:00
docker-compose.yml Move additional files into dedicated folder and make build the def... 2020-08-11 15:38:24 +02:00
Dockerfile Move additional files into dedicated folder and make build the def... 2020-08-11 15:38:24 +02:00
LICENSE
README.md docs: add documentation to the repo and improve layout 2020-08-12 21:17:53 +02:00
Rocket-example.toml
rust-toolchain
rustfmt.toml

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

Build the docker image 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