jimzah/conduit
1
0
Fork 0
mirror of https://gitlab.com/famedly/conduit.git synced 2024-11-26 19:22:29 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
651 Commits 49 Branches 8 Tags 7.3 MiB
Rust 97.4%
Nix 0.9%
Python 0.7%
Shell 0.6%
Dockerfile 0.4%
5bf43a4d7e
Go to file
Paul van Tilburg 5bf43a4d7e
Generate conduit.toml instead of debian environment file 
Only generate this file once. I am not sure what to do with future
upgrades yet.
2021-04-22 21:52:40 +02: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
.vscode add settings.json 2021-03-14 11:55:28 +01:00
debian Generate conduit.toml instead of debian environment file 2021-04-22 21:52:40 +02:00
docker Fix order of docker command arguments and change repository link to... 2020-10-18 23:06:08 +02:00
src improvement: use invite state as hints to what servers to ask for joining 2021-04-14 14:46:40 +02:00
tests Merge remote-tracking branch 'famedly/master' into develop 2021-04-14 10:26:28 +02:00
.dockerignore Update dockerignore 2020-09-17 20:14:07 +02:00
.gitignore Add more gitignore 2021-03-13 20:33:16 +01:00
Cargo.lock chore: bump stateres 2021-04-14 17:46:17 +02:00
Cargo.toml Generate conduit.toml instead of debian environment file 2021-04-22 21:52:40 +02:00
conduit-example.toml Generate conduit.toml instead of debian environment file 2021-04-22 21:52:40 +02:00
CROSS_COMPILE.md docs: Fix fix formatting of code blocks in markdown 2021-04-16 11:10:01 +02:00
DEPLOY.md docs: Fix fix formatting of code blocks in markdown 2021-04-16 11:10:01 +02:00
docker-compose.yml feat: federation disabled by default 2020-10-07 11:51:56 +02:00
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 chore: get rid of warnings 2021-03-18 18:33:43 +01: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 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