Skip to content
Snippets Groups Projects
README.md 2.34 KiB
Newer Older
  • Learn to ignore specific revisions
  • timo's avatar
    timo committed
    # Conduit
    
    timo's avatar
    timo committed
    ### A Matrix homeserver written in Rust
    
    timokoesters's avatar
    timokoesters committed
    
    
    #### What is the goal?
    
    Timo Kösters's avatar
    Timo Kösters committed
    
    
    An efficient Matrix homeserver that's easy to set up and just works. You can install
    
    Timo Kösters's avatar
    Timo Kösters committed
    it on a mini-computer like the Raspberry Pi to host Matrix for your family,
    friends or company.
    
    Timo Kösters's avatar
    Timo Kösters committed
    #### Can I try it out?
    
    timokoesters's avatar
    timokoesters committed
    
    
    Yes! You can test our Conduit instance by opening a Matrix client (<https://app.element.io> or Element Android for
    example) and registering on the `conduit.rs` homeserver.
    
    Timo Kösters's avatar
    Timo Kösters committed
    
    
    It is hosted on a ODROID HC 2 with 2GB RAM and a SAMSUNG Exynos 5422 CPU, which
    was used in the Samsung Galaxy S5. It joined many big rooms including Matrix
    HQ.
    
    Timo Kösters's avatar
    Timo Kösters committed
    #### What is the current status?
    
    TomZ's avatar
    TomZ committed
    Conduit is Beta, meaning you can join and participate in most
    
    Matrix rooms, but not all features are supported and you might run into bugs
    from time to time.
    
    Timo Kösters's avatar
    Timo Kösters committed
    
    There are still a few important features missing:
    
    
    Timo Kösters's avatar
    Timo Kösters committed
    - E2EE verification over federation
    - Outgoing read receipts, typing, presence over federation
    
    
    Check out the [Conduit 1.0 Release Milestone](https://gitlab.com/famedly/conduit/-/milestones/3).
    
    
    Timo Kösters's avatar
    Timo Kösters committed
    #### How can I deploy my own?
    
    
    Jonas Zohren's avatar
    Jonas Zohren committed
    - Simple install (this was tested the most): [DEPLOY.md](DEPLOY.md)
    - Debian package: [debian/README.Debian](debian/README.Debian)
    - Docker: [docker/README.md](docker/README.md)
    
    If you want to connect an Appservice to Conduit, take a look at [APPSERVICES.md](APPSERVICES.md).
    
    timokoesters's avatar
    timokoesters committed
    #### How can I contribute?
    
    
    Timo Kösters's avatar
    Timo Kösters committed
    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
    
    Jonas Zohren's avatar
    Jonas Zohren committed
       [#conduit:fachschaften.org](https://matrix.to/#/#conduit:fachschaften.org))
    3. Fork the repo and work on the issue.[#conduit:fachschaften.org](https://matrix.to/#/#conduit:fachschaften.org) is happy to help :)
    
    4. Submit a MR
    
    timokoesters's avatar
    timokoesters committed
    
    
    Timo Kösters's avatar
    Timo Kösters committed
    #### Thanks to
    
    Thanks to Famedly, Prototype Fund (DLR and German BMBF) and all other individuals for financially supporting this project.
    
    Thanks to the contributors to Conduit and all libraries we use, for example:
    
    - Ruma: A clean library for the Matrix Spec in Rust
    
    Jonas Platte's avatar
    Jonas Platte committed
    - axum: A modular web framework
    
    Timo Kösters's avatar
    Timo Kösters committed
    Liberapay: <https://liberapay.com/timokoesters/>\
    
    Timo Kösters's avatar
    Timo Kösters committed
    Bitcoin: `bc1qnnykf986tw49ur7wx9rpw2tevpsztvar5x8w4n`
    
    
    #### Logo
    
    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