#matrix #fractal

fractal-matrix-api

Library to communicate with a Matrix.org server

5 stable releases

4.2.0 Jul 29, 2019
4.0.0 Jan 10, 2019
3.30.0 Sep 6, 2018
3.29.4 Jul 25, 2018
3.29.0 Jun 8, 2018

#805 in Network programming

Download history 38/week @ 2023-10-27 27/week @ 2023-11-03 24/week @ 2023-11-10 39/week @ 2023-11-17 34/week @ 2023-11-24 30/week @ 2023-12-01 25/week @ 2023-12-08 31/week @ 2023-12-15 37/week @ 2023-12-22 12/week @ 2023-12-29 26/week @ 2024-01-05 29/week @ 2024-01-12 30/week @ 2024-01-19 31/week @ 2024-01-26 20/week @ 2024-02-02 25/week @ 2024-02-09

112 downloads per month
Used in matrix_bot_api

GPL-3.0 license

150KB
4K SLoC

Our chat room Our Gitlab project Our documentation Official package

Fractal

Fractal is a Matrix messaging app for GNOME written in Rust. Its interface is optimized for collaboration in large groups, such as free software projects, and will fit all screens, big or small.

screenshot

Highlights:

  • Find rooms to discuss your favorite topics, or talk privately to people, securely thanks to end-to-end encryption
  • Send rich formatted messages, files, or your current location
  • Reply to specific messages, react with emoji, edit or remove messages
  • View images, and play audio and video directly in the conversation
  • See who has read messages, and who is typing
  • Log into multiple accounts at once (with Single-Sign On support)

Contents

[TOC]

Installation instructions

Flatpak is the recommended installation method. For installing any of our Flatpaks, you need to make sure your system is set up with the Flathub remote.

All of our Flatpaks can be installed in parallel, offering you the opportunity to try out the development version while keeping the stable release around for daily use.

Stable version

The current stable version is 6 (released January 18th 2024).

You can get the official Fractal Flatpak from Flathub.

Download Fractal on Flathub

Beta version

The current beta version is 6, same as the stable version (released January 18th 2024).

It is available as a Flatpak on Flathub Beta.

To get it, first set up the Flathub Beta remote:

Add Flathub Beta repository

Then install the application.

Download Fractal Beta

Or from the command line:

# Add the Flathub Beta repo
flatpak remote-add --user --if-not-exists flathub-beta https://flathub.org/beta-repo/flathub-beta.flatpakrepo

# Install Fractal Beta
flatpak install --user flathub-beta org.gnome.Fractal

Finally, run the application:

flatpak run org.gnome.Fractal//beta

If you have both the stable and beta versions installed, your system will only show one icon in the apps list and launch the stable version by default. If you want to run the beta version by default, use this command:

flatpak make-current org.gnome.Fractal beta

Note that you can go back to using the stable version by default by using the same command and replacing beta with stable.

Development version

If you want to try the upcoming version of Fractal without building it yourself, it is available as a nightly Flatpak in the gnome-nightly repo.

First, set up the GNOME nightlies.

Add gnome-nightly repository

Then install the application.

Download Fractal Nightly

Or from the command line:

# Add the gnome-nightly repo
flatpak remote-add --user --if-not-exists gnome-nightly https://nightly.gnome.org/gnome-nightly.flatpakrepo

# Install the nightly build
flatpak install --user gnome-nightly org.gnome.Fractal.Devel

Runtime Dependencies

Fractal doesn’t store your password, but it stores your access token and the passphrase used to encrypt the database and the local cache.

The Fractal Flatpaks use the Secret Portal to store those secrets. If you are using GNOME this should just work. If you are using a different desktop environment or are facing issues, make sure xdg-desktop-portal is installed along with a service that provides the Secret portal backend interface, which is currently only implemented by gnome-keyring.

Any version that is not sandboxed relies on software that implements the Secret Service API to store those secrets. Therefore, you need to have software providing that service on your system, like gnome-keyring, KeepassXC (setup guide), or KWallet (since version 5.97). Once again, if you are using GNOME this should just work.

If you prefer to use software that only implements the Secret Service API while using the Flatpaks, you need to make sure that no service implementing the Secret portal backend interface is running, and you need to allow Fractal to access the D-Bus service with this command:

flatpak override --user --talk-name=org.freedesktop.secrets org.gnome.Fractal

For the nightly version, change the application name to org.gnome.Fractal.Devel.

Or with Flatseal, by adding org.freedesktop.secrets in the Session Bus > Talk list of Fractal.

Security Best Practices

You should use a strong password that is hard to guess to protect the secrets stored on your device, whether the password is used directly to unlock your secrets (with a password manager for example) or if it is used to open your user session and your secrets are unlocked automatically (which is normally the case with a GNOME session).

Furthermore, make sure to lock your system when stepping away from the computer since an unlocked computer can allow other people to access your private communications and your secrets.

Contributing

Code

Please follow our contributing guidelines.

Translations

Fractal is translated by the GNOME translation team on Damned lies.

Find your language in the list on the Fractal module page on Damned lies.

The names of the emoji displayed during verification come from the Matrix specification repository. They are translated on Element’s translation platform.

Frequently Asked Questions

  • Does Fractal have encryption support?

Yes, since Fractal 5, encryption is supported using Cross-Signing. See https://gitlab.gnome.org/World/fractal/-/issues/717 for more info on the state of encryption.

  • Can I run Fractal with the window closed?

Currently Fractal does not support this. Fractal is a GNOME application, and accordingly adheres to the GNOME guidelines and paradigms. This will be revisited if or when GNOME gets a proper paradigm to interact with apps running in the background.

The origin of Fractal

The current version is a complete rewrite of Fractal built on top of the matrix-rust-sdk using GTK4.

The previous version of Fractal was using GTK3 and its own backend to talk to a matrix homeserver, the code can be found in the legacy branch.

Initial versions were based on Fest https://github.com/fest-im/fest, formerly called ruma-gtk. In the origins of the project it was called guillotine, based on French revolution, in relation with the Riot client name, but it's a negative name so we decide to change for a math one.

The name Fractal was proposed by Regina Bíró.

Code of Conduct

Fractal follows the official GNOME Code of Conduct.

Dependencies

~28MB
~618K SLoC