Description
Ruma is a Matrix homeserver. In order to understand what that means, you first need to understand Matrix.
Matrix is a protocol for communicating online.
Matrix-powered apps, called Matrix clients, have all the features you'd want and expect from a modern chat app: instant messaging, group chats, audio and video calls, searchable message history, synchronization across all your devices, and more.
To use a Matrix client, you create an account on a Matrix homeserver. Your Matrix homeserver is your hub into the Matrix network. It stores your account information and all your conversations. You can communicate with people on your own homeserver or people on other homeservers. When you communicate with people on other homeservers, your homeserver and the other homeservers involved synchronize the conversation history. This allows you to communicate with anyone in the Matrix network seamlessly, without ever thinking about which homeserver they connect to.
Popular Comparisons
README
Ruma – Your home in Matrix.
A set of Rust crates (libraries) for interacting with the Matrix chat network.
website • chat • documentation (unstable)
Getting started
If you want to build a Matrix client or bot, have a look at matrix-rust-sdk. It builds on Ruma and includes handling of state storage, end-to-end encryption and many other useful things.
For homeservers, bridges and harder-to-categorize software that works with
Matrix, you're at the right place. To get started, add ruma
to your
dependencies:
# crates.io release
ruma = { version = "0.7.4", features = ["..."] }
# git dependency
ruma = { git = "https://github.com/ruma/ruma", branch = "main", features = ["..."] }
ruma
re-exports all of the other crates, so you don't have to worry about
them as a user. Check out the documentation on docs.rs (or on
docs.ruma.io if you use use the git dependency).
Status
Ruma 0.7 supports all events and REST endpoints of Matrix v1.3.
Various changes from in-progress or finished MSCs are also implemented, gated
behind the unstable-mscXXXX
(where XXXX
is the MSC number) Cargo features.
A few less formalized things are gated behind the unstable-unspecified
Cargo
feature.
Contributing
See [CONTRIBUTING.md](CONTRIBUTING.md).
Minimum Rust version
Ruma currently requires Rust 1.64. In general, we will never require beta or nightly for crates.io releases of our crates, and we will try to avoid releasing crates that depend on features that were only just stabilized.
ruma-signatures
is an exception: It uses cryptographic libraries that often
use relatively new features and that we don't want to use outdated versions of.
It is guaranteed to work with whatever is the latest stable version though.
License
*Note that all licence references and agreements mentioned in the Ruma README section above
are relevant to that project's source code only.