MirrorHub/conduit
1
0
Fork 0
mirror of https://gitlab.com/famedly/conduit.git synced 2024-11-05 03:58:52 +01:00
Code Issues Releases Activity
No description
1000 commits 50 branches 6 tags 12 MiB
Rust 95.8%
Python 2.1%
Dockerfile 1.3%
Shell 0.8%
Find a file
Daniel Wiesenberg a08ea15695 Use $CI_COMMIT_SHORT_SHA for GIT_REF 
Using `$CI_COMMIT_REF_NAME` means we get `master` for every image build,
which is not very useful/informative. Using `$CI_COMMIT_SHORT_SHA`,
on the other hand, makes it possible to see exactly from which commit an
image was built.
2021-08-31 18:03:44 +02: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 Shorten more templates 2021-07-18 20:43:21 +00:00
.vscode add settings.json 2021-03-14 11:55:28 +01:00
debian Sqlite 2021-07-14 07:07:08 +00:00
docker Change healthcheck in ci dockerfile 2021-08-30 09:14:08 +02:00
src add warning if calculated event id != requested event id 2021-08-28 19:35:42 +02:00
tests CI: Test registration with element web 2021-07-19 08:23:04 +00:00
.dockerignore Update dockerignore 2020-09-17 20:14:07 +02:00
.gitignore Sqlite 2021-07-14 07:07:08 +00:00
.gitlab-ci.yml Use $CI_COMMIT_SHORT_SHA for GIT_REF 2021-08-31 18:03:44 +02:00
APPSERVICES.md docs: APPSERVICES setup guide 2021-05-22 13:55:28 +02:00
Cargo.lock Use Arc<EventId> in place of most EventIds 2021-08-27 20:20:14 +02:00
Cargo.toml Use Arc<EventId> in place of most EventIds 2021-08-27 20:20:14 +02:00
conduit-example.toml docs: make it clear that database_path is a folder 2021-07-30 19:27:37 +02:00
CROSS_COMPILE.md Merge branch 'tls-name' into 'master' 2021-04-23 05:22:07 +00:00
DEPLOY.md Use full optimizations for master and faster config else 2021-08-14 21:41:27 +02:00
docker-compose.yml Bump version of alpine docker image to 3.14 2021-08-09 21:21:18 +02:00
Dockerfile Move docker healthcheck into dedicated script. 2021-08-29 20:01:38 +02:00
LICENSE Change license to Apache-2.0 2020-10-18 13:47:52 +02:00
README.md docs: Initial end-to-end encryption over federation support 2021-07-20 21:37:08 +02:00
rust-toolchain fix toolchain 2021-07-14 15:46:30 +02: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 built 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 is the current status?

Conduit can already be used chat with other users on Conduit, chat with users from other Matrix servers and even to chat with users on other platforms using appservices. When chatting with users on the same Conduit server, everything should work assuming you use a compatible client.

You should not join Matrix rooms without asking the admins first. We do not know whether Conduit is safe for general use yet, so you should assume there is some chance that it breaks rooms permanently for all participating users. We are not aware of such a bug today, but we would like to do more testing.

There are still a few important features missing:

  • Database stability (currently you might have to do manual upgrades or even wipe the db for new versions)
  • Edge cases for end-to-end encryption over federation
  • Typing and presence over federation
  • 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

If you want to connect an Appservice to Conduit, take a look at the Appservice Guide.

Deploy using a Debian package

You need to have the deb helper command installed that creates Debian packages from Cargo projects (see cargo-deb for more info):

$ cargo install cargo-deb

Then, you can create and install a Debian package at a whim:

$ cargo deb
$ dpkg -i target/debian/matrix-conduit_0.1.0_amd64.deb

This will build, package, install, configure and start Conduit. Read more.

Note that cargo deb supports cross-compilation too! Official Debian packages will follow once Conduit starts to have stable releases.

Deploy using Docker

Pull and run the docker image with

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

Note: You also need to supply a conduit.toml config file, you can find an example here. Or you can pass in -e CONDUIT_CONFIG="" and configure Conduit purely with env vars.

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