10 KiB
Installation
Instructions and releases are currently only available for Linux,
but compiling on Windows and macOS should be possible with the right tools.
- Packages
- Manual installation
Packages
Linux
For developement, or if none of the package options are satisfying,
see manual installation.
Packages other than the Flatpak are not maintained by the Moment
authors, and thus might be outdated.
Flatpak
Moment is also available as a Flatpak.
- Download the Moment Flatpak from
Flathub. Alternatively,
you can issue the following commands in a terminal:
flatpak remote-add --if-not-exists \
flathub https://flathub.org/repo/flathub.flatpakrepo
flatpak install flathub xyz.mx_moment.moment
flatpak run xyz.mx_moment.moment
- If your operating system doesn't already have built-in support for Flatpaks,
follow these instructions to install Flatpak
support on your system.
Configuration migration
Note that automatic migration of data from Mirage is not supported when using
Flatpak. If you would like to manually migrate your logins, encryption keys,
configuration and themes from Mirage, you can do it like so:
Migration from Mirage's Flatpak
Issue the following commands:
$ mkdir -p ~/.var/app/xyz.mx_moment.moment/{config,data}
$ cd ~/.var/app
$ cp -r io.github.mirukana.mirage/config/mirage/* xyz.mx_moment.moment/config/moment
$ cp -r io.github.mirukana.mirage/data/mirage/* xyz.mx_moment.moment/data/moment
Migration from a distribution package
Issue the following commands:
$ mkdir -p ~/.var/app/xyz.mx_moment.moment/{config,data}
$ cd ~/.var/app
If you are on Debian, replace mirage with mirage-matrix in the following
commands:
$ cp -r ~/.config/mirage/* xyz.mx_moment.moment/config/moment
$ cp -r ~/.local/share/mirage/* xyz.mx_moment.moment/data/moment
Alpine Linux / postmarketOS
If you are on the Edge channel of Alpine Linux or postmarketOS, Moment can be
installed right from the testing repositry:
apk add moment
If you are unsure about what Edge is and want to read more about it, you can do
so on the Alpine Wiki.
Arch Linux
AUR packages for the
latest stable release and
git dev branch are
available.
Installing the release version with an AUR helper, e.g.
yay:
yay -S moment
Manual Installation
Qt 5.12+, Python 3.6+ (with pip to install packages from the
requirements.txt), PyOtherSide 1.5+ and
libolm 3+ are required.
The equivalent -dev or -devel packages are needed, if your distro
splits development headers into their own packages.
To enable X11-specific features on Linux,
libX11 and libXScrnSaver / libXss are needed.
The requirements can be disabled by adding CONFIG+=no-x11 to the
qmake moment.pro command.
For the Pillow Python package, these dependencies are recommended to support
all common image formats:
- libjpeg-turbo
- zlib
- libtiff
- libwebp
- openjpeg2
libmediainfo is also required for the pymediainfo package.
Environment Variables
To ensure Qt 5 will be used by default, compile using all CPU cores and
optimize the build for your machine:
export QT_SELECT=5
export MAKEFLAGS="-j$(nproc)"
export CFLAGS="-march=native -O2 -pipe"
Package Manager Dependencies
Alpine Linux 3.9+ / apk
PyOtherSide and
libolm must be manually installed.
sudo apk add qt5-qtquickcontrols2-dev qt5-qtsvg-dev qt5-qtimageformats \
libx11-dev libxscrnsaver-dev alsa-lib-dev \
python3-dev py3-setuptools \
build-base git cmake \
libjpeg-turbo-dev zlib-dev tiff-dev libwebp-dev openjpeg-dev \
libmediainfo-dev
export PATH="/usr/lib/qt5/bin:$PATH"
Arch Linux / pacman & AUR
libolm is from the AUR, this example uses
yay to install it like other packages.
Alternatively, you can just use pacman and
install libolm manually.
yay -Syu qt5-base qt5-declarative qt5-quickcontrols2 qt5-svg \
qt5-graphicaleffects qt5-imageformats \
libx11 libxss alsa-lib \
python python-pip \
python-pyotherside \
libolm \
base-devel git cmake \
libjpeg-turbo zlib libtiff libwebp openjpeg2 libmediainfo
Fedora 30+ / dnf
sudo dnf groupinstall 'Development Tools'
sudo dnf install qt5-devel qt5-qtbase-devel qt5-qtdeclarative-devel \
qt5-qtquickcontrols2-devel qt5-qtsvg-devel \
qt5-qtgraphicaleffects qt5-qtimageformats \
python3-devel python3-pip pyotherside \
libX11-devel libXScrnSaver-devel alsa-lib-devel \
git cmake \
libolm-devel \
libjpeg-turbo-devel zlib-devel libtiff-devel libwebp-devel \
openjpeg2-devel libmediainfo-devel
sudo ln -s /usr/bin/qmake-qt5 /usr/bin/qmake
Gentoo / emerge
libolm must be manually installed.
You might need to prepend the emerge command with USE=bindist,
if emerge says so.
sudo emerge -av qtcore qtdeclarative qtquickcontrols2 \
qtsvg qtgraphicaleffects qtimageformats \
libX11 libXScrnSaver alsa-lib \
dev-python/pip pyotherside \
dev-vcs/git cmake \
libjpeg-turbo zlib tiff libwebp openjpeg libmediainfo
Ubuntu 19.04 / apt
libolm must be manually installed.
sudo apt update
sudo apt install qt5-default qt5-qmake qt5-image-formats-plugins \
qml-module-qtquick2 qml-module-qtquick-window2 \
qml-module-qtquick-layouts qml-module-qtquick-dialogs \
qml-module-qt-labs-platform \
qml-module-qtquick-shapes \
qtdeclarative5-dev \
qtquickcontrols2-5-dev \
libx11-dev libxss-dev libasound2-dev \
python3-dev python3-pip \
qml-module-io-thp-pyotherside \
build-essential git cmake \
libjpeg-turbo8-dev zlib1g-dev libtiff5-dev libwebp-dev \
libopenjp2-7-dev libmediainfo-dev
Ubuntu 19.10+, Debian bullseye / apt
Follow the steps for Ubuntu 19.04, but instead of
installing libolm manually:
sudo apt install libolm-dev
Void Linux / xbps
PyOtherSide must be manually installed.
sudo xbps-install -Su qt5-devel qt5-declarative-devel \
qt5-quickcontrols2-devel \
qt5-svg-devel qt5-graphicaleffects qt5-imageformats \
libx11-devel libXScrnSaver-devel alsa-lib-devel \
python3-devel python3-pip \
olm-devel \
base-devel git cmake \
libjpeg-turbo-devel zlib-devel tiff-devel libwebp-devel \
libopenjpeg2-devel libmediainfo-devel
Installing PyOtherSide Manually
Skip this section if you already installed it from your
distro's package manager.
git clone https://github.com/thp/pyotherside
cd pyotherside
make clean
qmake
make
sudo make install
Installing libolm Manually
Skip this section if you already installed it from your
distro's package manager.
git clone https://gitlab.matrix.org/matrix-org/olm/
cd olm
cmake . -Bbuild
cmake --build build
sudo make install
Installing or updating Moment
After following the above sections instructions depending on your system;
clone the repository, initalize the submodules,
install the python dependencies, compile and install:
git clone https://gitlab.com/mx-moment/moment
cd moment
git pull
git submodule update --init submodules/*
pip3 install --user -Ur requirements.txt
qmake moment.pro
make
sudo make install
To compile without the X11-specific dependencies and features on Linux,
run qmake moment.pro CONFIG+=no-x11 instead of qmake moment.pro.
If everything went fine, run moment to start.
Common Issues
cffi version mismatch
When installing the python dependencies, if you get a version mismatch error
related to cffi, try:
pip3 install --user --upgrade --force-reinstall cffi
Type XYZ unavailable
If the application exits without showing any window and you get a terminal
message like this:
file:///.../src/gui/Window.qml:83:5: Type PythonRootBridge unavailable
then a QML component/type failed to import due to either a missing
dependency or a programming error.
If the type has Python in its name, ensure PyOtherSide is correctly
installed. You should see a similar message:
Got library name: "/usr/lib/qt5/qml/io/thp/pyotherside/libpyothersideplugin.so"
To ensure the correct permissions are set for the PyOtherSide plugin files:
sudo chmod -R 755 /usr/lib/qt5/qml/io
sudo chmod 644 /usr/lib/qt5/qml/io/thp/pyotherside/*
sudo chmod 755 /usr/lib/qt5/qml/io/thp/pyotherside/*.so
Note that the Qt lib path might be /usr/lib/qt/ instead of /usr/lib/qt5/,
depending on the distro.