Building from Source

To build from source, download the latest release tarball from the releases page and unpack it into a source folder. Consult the included README for the list of supported platforms and the list of required and optional dependencies and their minimum versions.

New in version 1.1: The server and client are now distributed in separate tarballs.

Install the required dependencies on your build machine. For library dependencies, remember to install the "development" version of the package (often named with a "-devel" suffix) in addition to the regular library package. Any dependencies which aren't provided by your distribution will need to be built from source. How to do that is beyond the scope of this documentation, although there are a few hints below about the more difficult dependencies.

Once the dependencies are in place, run cmake to configure the build. This can be done using the included runcmake.sh or by running cmake directly. Take a look at the top of runcmake.sh for configuration lines that can be un-commented and changed. By default, the script will set up the build to make both server and client in release mode with the output folder set to build/ within the source tree.

Once the build is configured, change into the output folder and run make to build and make install to install. See the sections below for more build instructions. If you find a bug or area of improvement or just need help with the build, refer to Getting Help.

Building the Server

Building termy-server by itself is relatively easy due to its lack of dependencies.

If termy-server will be installed on a machine that uses systemd-logind to manage user login sessions, you'll need to enable the systemd support by setting the CMake variable USE_SYSTEMD. Follow the instructions at Systemd Setup once you've gotten it installed.

If termy-server will be installed on any machine that hosts git repositories or working trees, enabling the libgit2 support is recommended. Do this by setting the CMake variable USE_LIBGIT2. Note that libgit2 is dynamically loaded by the server at runtime, so the library is not required to be present even if the support for it is enabled.

Setting the CMake variable INSTALL_SHELL_INTEGRATION will install the shell integration scripts distributed with TermySequence. This removes the need for users to manually install shell integration, provided they use certain shells. See Shell Integration.

Building the Client

Make sure that the Base, Svg, and Tools (linguist) components of Qt5 are all installed, including the "development" versions of the packages. If Qt5 is not packaged by your distribution, it can be downloaded from qt.io (the free open source version is what you want). If CMake can't locate FindQt5.cmake, define the CMake variable Qt5_DIR to the full path of the appropriate cmake/Qt5 folder (such as clang_64/lib/cmake/Qt5) within the Qt installation. runcmake.sh reads this value from the environment variable QT5_CMAKE_DIR if set.

As with the server, if qtermy will be installed on a machine that uses systemd-logind to manage user login sessions, you'll need to enable the systemd support and follow the instructions at Systemd Setup once you've gotten it installed.

New in version 1.1: The Chrome V8 engine by Google is now bundled in the client tarball and built automatically. Downloading and building V8 separately is no longer required. Refer to the V8 Public Wiki for more information on Chrome V8. If not building on amd64, it may be necessary to set the V8_ARCH and V8_ARMFP CMake variables appropriately.

New in version 1.1: qtermy now supports either version 2 or version 3 of the libfuse FUSE library. Set the CMake variables USE_FUSE3 or USE_FUSE2 to enable one or the other version. By default, version 3 is enabled. Set both variables to OFF to disable FUSE support.

New in version 1.1: The termy-icon-theme and termy-emoji graphical content is now bundled in the client tarball. Downloading and installing these separately is no longer required.