Help › Installing

Installing the desktop application

Reqlyn 0.5.1 is not released yet. This help describes it ahead of release.

This covers the desktop application and the command line. The server is installed step by step as INSTALL_SERVER.md says; every setting is in DEPLOYMENT.md.

Platform Package State
Windows 10 and 11, x64 Reqlyn-<version>-x64.msi Built and tried on Windows 11 (M7.4a)
macOS none yet Pending (M7.4b): needs a Mac to build and try on
Linux, x86-64 Reqlyn-<version>-x86_64-linux.tar.gz Built in a container and installed on a clean Debian 12 (M7.4c); its window opens, but what it draws has not been seen on a Linux desktop

A computer with no network installs the same packages from the offline bundle, which holds them with the server and the agent: DEPLOYMENT.md, "With no network".

Windows

What the package does

  • Installs for the person who runs it, and asks for no administrator.
  • Puts reqlyn-desktop.exe and the command line reqlyn.exe in %LOCALAPPDATA%\Programs\Reqlyn.
  • Adds a Start menu entry, Reqlyn.
  • Adds that folder to the person's PATH, so reqlyn is found in a terminal opened afterwards.
  • Needs nothing else installed: the C runtime is built into both programs.

Opened, it is an installation wizard: Welcome; the folder to install to, %LOCALAPPDATA%\Programs\Reqlyn unless you change it; Ready to install; its progress, file by file; and Completed, with "Open Reqlyn" ticked to open it when you press Finish. There is no licence page yet. To install without any window, as a deployment tool does:

msiexec /i Reqlyn-0.1.0-x64.msi /qn

A later version installed over an earlier one replaces it, and so does another package of the same version: there is only ever one Reqlyn in the list of installed applications. An earlier version is refused while a later one is installed.

Removing it

Remove Reqlyn from Settings, Apps, Installed apps ("Uninstall"). Or open the package again: on a computer that has Reqlyn it offers Repair, which puts back missing or damaged files, and Remove, each with its progress. Without any window:

msiexec /x Reqlyn-0.1.0-x64.msi /qn

This removes the two programs, the Start menu entry, and the folder from PATH. It leaves what you made: the data folder %APPDATA%\Reqlyn, and the secrets kept in Windows Credential Manager. Remove those by hand if you want them gone.

The package is not signed

The package and the programs in it carry no signature. On a computer that has not seen the file before, Windows may show "Windows protected your PC" with an unknown publisher; "More info" and "Run anyway" goes on. An organization that allows only signed software will refuse it.

Without a signature, check the file by its SHA-256 before you run it. The build writes Reqlyn-<version>-x64.msi.sha256 beside the package; get that value from whoever built it, by a way you trust, and compare:

certutil -hashfile Reqlyn-0.1.0-x64.msi SHA256

There is no updater: a new version is installed by running its package.

Building the package

Needs the Rust toolchain named in rust-toolchain.toml, the WiX toolset, version 5 (dotnet tool install --global wix), and its UI and Util extensions (wix extension add -g WixToolset.UI.wixext/5.0.2, and the same for WixToolset.Util.wixext/5.0.2).

powershell -File apps\desktop\windows\package.ps1

The package and its SHA-256 are written to target\package. The version is the workspace's, from Cargo.toml. The package's source is apps/desktop/windows/reqlyn.wxs; its UpgradeCode must never change. The wizard's two pictures are drawn from the icon by installer-art.ps1 as the package is built.

Linux

What the package does

The package is a folder in a .tar.gz. Its install.sh installs for the person who runs it, and needs no administrator:

  • reqlyn-desktop and the command line reqlyn go in ~/.local/bin;
  • a menu entry, Reqlyn, goes in ~/.local/share/applications, and its icon under ~/.local/share/icons.
tar -xzf Reqlyn-0.1.0-x86_64-linux.tar.gz
Reqlyn-0.1.0-x86_64-linux/install.sh

If ~/.local/bin is not on PATH, the script says so. Running a later version's install.sh replaces the earlier one. The programs link OpenSSL 3 (libssl3), which MQTT over TLS is carried on. The desktop needs an X11 or Wayland session with Vulkan, which a desktop computer's graphics driver gives, and a secret service (GNOME Keyring, KWallet) for the secrets it keeps.

Removing it

Reqlyn-0.1.0-x86_64-linux/install.sh --uninstall

This removes the two programs, the menu entry and the icon. It leaves what you made: the data folder ~/.local/share/Reqlyn, and the secrets in the secret service.

The package is not signed

Check it by its SHA-256, written beside it as Reqlyn-<version>-x86_64-linux.tar.gz.sha256, against a value you got from whoever built it by a way you trust:

sha256sum -c Reqlyn-0.1.0-x86_64-linux.tar.gz.sha256

There is no updater.

Building the package

On Linux, with the Rust toolchain named in rust-toolchain.toml and the libraries apps/desktop/linux/Dockerfile installs:

sh apps/desktop/linux/package.sh

On another system, in a container. The shared crates are fetched over SSH, which the container has no key for, so the dependencies are vendored first on the computer that has the access:

cargo vendor --locked target/linux-vendor > target/linux-vendor.toml
docker build -f apps/desktop/linux/Dockerfile -o target/package .

Either way the package and its SHA-256 are written to target/package.

Help for Reqlyn 0.5.1. All help topics