fractal/README.md
Alexandre Franke 6c48cde678
Release 5
2023-11-24 19:05:09 +01:00

8.3 KiB
Raw Blame History

Our chat room Our Gitlab project Our documentation

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)

Installation instructions

Stable version

The current stable version is 5 (released November 24th 2023).

Flatpak is the recommended installation method. Until our next iteration is ready, you can get the official Fractal Flatpak from Flathub.

Download Fractal on Flathub

Beta version

The current beta version is 5 (same as stable, released November 24th 2023).

It is available as a Flatpak on Flathub Beta.

To get it, first ensure that the Flathub remote is present to provide the necessary runtimes:

flatpak remote-add --user --if-not-exists flathub https://dl.flathub.org/repo/flathub.flatpakrepo

Or download and install the Flathub repository file

Then, set up the Flathub Beta remote:

flatpak remote-add --user --if-not-exists flathub-beta https://flathub.org/beta-repo/flathub-beta.flatpakrepo

Or download and install the Flathub Beta repository file.

Then, install the application:

flatpak install --user flathub-beta org.gnome.Fractal

Or download and install the application file.

Finally, run the application:

flatpak run org.gnome.Fractal//beta

If you want to run the beta version by default instead of the stable version, 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 doesnt store your password, but it stores your access token and the passphrase used to encrypt the database and the local cache.

The stable Flatpak available on Flathub and any version that is not sandboxed rely 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 a recent version of KWallet. If you are using GNOME this should just work.

With the nightly and beta Flatpaks, Fractal uses the Secret portal to store those secrets. Once again, 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.

If you prefer to use other software that only implements the Secret Service API while using the nightly or beta Flatpak, 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 Elements 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/GNOME/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 Foundation code of conduct. You can read it here.