Changes

This guide will step you through building the The [https://looking -glass client from source.io/docs/stable/install Official Documentation] contains installation instructions for Debian-based distributions and should work fine on derivatives. The following are supplemental guides for other distributions, before you attempt to which do this you should have a basic understanding of how to use not work using the shellDebian instructions.

=== Building the Application ===<!--Debian example for reference. Do not include --==== Installing Build Dependencies ====!

* apt-get install binutils-dev* cmake* fonts-freefont-ttf* libsdl2libfontconfig1-dev* libsdl2-ttflibegl-dev* libspice-protocol-dev* libfontconfig1nettle-dev* libx11-devlibxi-dev libxinerama-dev libxss-dev libwayland-dev wayland-protocols* nettle-dev->

===== Debian (and maybe Ubuntu) ===Fedora 35+ ==

aptdnf install cmake gcc gcc-c++ libglvnd-devel fontconfig-devel spice-protocol make nettle-devel \ pkgconf-pkg-get install config binutils-dev cmake fontsdevel libXi-devel libXinerama-devel libXcursor-devel \ libXpresent-devel libxkbcommon-freefontx11-ttf libsdl2devel wayland-dev libsdl2devel wayland-ttfprotocols-dev libspicedevel \ libXScrnSaver-protocoldevel libXrandr-dev libfontconfig1devel dejavu-dev libx11sans-dev nettlemono-devfonts

yum dnf install make cmake binutilspulseaudio-devel SDL2libs-devel SDL2_ttflibsamplerate-devel nettle-devel spice-protocol fontconfig-devel libX11-devel egl-wayland</syntaxhighlight> === Installing Additional Dependencies for Kernel Module Build === <syntaxhighlight lang=bash>dnf install dkms kernel-devel waylandkernel-devel mesa-libGLU-devel mesa-libGLES-devel mesa-libGL-devel mesa-libEGL-develheaders

===== OpenSuSE Leap 15.0+ =====

zypper install binutils-devel make cmake binutilsfontconfig-devel libSDL2-devel libSDL2_ttf-devel spice-protocol-devel libX11-devel libnettle-devel nettle spicewayland-protocolprotocols-devel fontconfig\ libconfig-devel libX11libXi-devel libconfiglibXss-devel libwayland-egl-develnettle

===== Arch / Manjaro ==Tumbleweed === For Tumbleweed this should do the trick:

sudo pacman -Syu zypper in binutils-dev devel clang cmake dejavu-sans-mono-fontsfontconfig-devel gcc gcc-c++ glibc-all-langpacks libdecor-devel libglvnd-devel libnettle-devel libpulse-devel libsamplerate-devel libSDL2-freefontdevel libSDL2_ttf-ttf libsdl2devel libvulkan1 libwayland-egl-devel libxkbcommon-devel libXpresent-devel libXrandr-devel libXScrnSaver-devel libXss-devel make Mesa-libGLESv3-devel nettle-devel pipewire-dev libsdl2devel pkgconf-ttfpkg-dev libspiceconfig pkgconfig spice-protocol-dev bfontconfig1devel vulkan-dev libx11loader wayland-dev devel zlib-devel-static</syntaxhighlight > == Arch Linux / Manjaro == === Installing Dependencies for Client Build === <!-- Dependencies must match Debian's order, and extra dependencies must be on another line, with a consistent order --><syntaxhighlight lang=bash>pacman -Syu cmake gcc libgl libegl fontconfig spice-protocol make nettlepkgconf binutils \ libxi libxinerama libxss libxcursor libxpresent libxkbcommon wayland-protocols \ ttf-devdejavu libsamplerate

==== Downloading =Installing Additional Dependencies for Kernel Module Build ===

==== Building ==Void Linux ==

If you downloaded the file via the web link then you should have a === Installing Dependencies === <!-- Dependencies must match Debian'zip' file. Simply unzip s order, and cd into the new directory. If you used 'git' then cd into the 'LookingGlass' directory. extra dependencies must be on another line, with a consistent order --><pre stylesyntaxhighlight lang="white-space: pre-wrap; bash>whitexbps-space: install -mozSyu binutils-predevel cmake freefont-wrap; whitettf fontconfig-space: devel SDL2-predevel SDL2_ttf-wrap; whitedevel spice-space: protocol libX11-odevel libXpresent-predevel libXinerama-wrap; worddevel nettle-wrap: break-word;">mkdir buildcd buildcmake ../devel \ gcc makepkg-config</presyntaxhighlight>

;NOTE: The most common compile error is related to backtrace support this can be disabled by adding the following option to the cmake command. '''-DENABLE_BACKTRACE=0''', however, if you disable this and need support for a crash please be sure to use gdb to obtain a backtrace manually or there is nothing that can be done to help you.= Gentoo ==

Should this all go well you should be left with === Installing Dependencies ===First set up the file '''lookingnecessary USE flags if needed:<syntaxhighlight lang=bash>echo "media-glasslibs/libsdl2 gles2" >> /etc/portage/package.use/libsdl2echo "media-client'''libs/nettle gmp" >> /etc/portage/package. Before you run use/nettle</syntaxhighlight>Then fetch the client you will first need to configure either Libvirt or Qemu (whichever you prefer) packages: <!-- Dependencies must match Debian's order, and then set up the Windows side service.extra dependencies must be on another line, with a consistent order --><syntaxhighlight lang=bash>emerge sys-devel/binutils dev-util/cmake media-fonts/freefonts media-libs/libsdl2 media-libs/sdl2-ttf app-emulation/spice-protocol \ media-libs/fontconfig dev-libs/nettle media-libs/libsamplerate \ media-libs/glu</syntaxhighlight>This list can also be placed into a setfile in /etc/portage/sets/ so that they can be updated with <syntaxhighlight lang=bash>emerge @setfile</syntaxhighlight>

==Proxmox = libvirt Configuration ===----This article assumes you already have a fully functional libvirt VM with PCI Passthrough working on a dedicated monitor. If you do not please ensure this is configured before you proceed.

Add the following to the libvirt machine configuration inside the 'devices* A working Proxmox install on a computer with 2 GPU' section by running "virsh edit VM" where VM is the name of your virtual machines (Tested with 7.<pre style="white1-space: pre-wrap; 6)white* A Windows VM with GPU pass-space: -moz-pre-wrap; through working (Tested with Win 10)white* A Linux VM with GPU pass-space: -pre-wrap; through working (Tested With Ubuntu 21.10)white-space: -o-pre-wrap; word-wrap: break-word;"><shmem name='looking-glass'> <model type='ivshmem-plain'/> <size unit='M'>32</size></shmem></pre>* Proxmox Host Installed and running on the Windows VM

The memory size (show as 32 in During Proxmox 7 lifecycle they shipped a newer OVMF firmware than tested, and breaks '''kvmfr''' module. Currently the example above may need workaround is to be adjusted as per [[Installation#Determining_Memory|Determining Memory]] section.use an older version of it:

=== Qemu Commands === apt install pve-edk2---Add the following to the commands to your QEMU command line, adjusting the bus to suit your particular configuration: <pre stylefirmware="white3.20220526-space: pre-wrap; 1white-space: -moz apt-premark hold pve-wrap; whiteedk2-space: -pre-wrap; white-space: -o-pre-wrap; word-wrap: break-word;">-device ivshmem-plain,memdev=ivshmem,bus=pcie.0 \-object memory-backend-file,id=ivshmem,share=on,mem-path=/dev/shm/looking-glass,size=32M</pre>firmware

The memory size (show as 32 For Proxmox 8, the current pve-edk2-firmware version 3.20230228-4 is tested to work with kvmfr 0.0.9 with Linux 6.4.3 in Linux VM. If you used the example workaround mentioned above may need to be adjusted as per [[Installation#Determining_Memory|Determining Memory]] section., you can revert it by:

=== Determining Memory === apt-mark unhold pve-edk2-firmware apt full-You will need to adjust the memory size to a value that is suitable for your desired maximum resolution using the following formula:upgrade

<pre style="white-space: pre-wrap; white-space: -moz-pre-wrap; white-space: -pre-wrap; white-space: -o-pre-wrap; word-wrap: break-word;">width x height x 4 x 2 = total bytestotal bytes / 1024 / 1024 = total megabytes + 2</pre>Windows VM setup ===

For exampleUsing the Proxmox GUI, for Set the Windows VM Display to "none" Then in a resolution shell to the Proxmox host edit the Windows VM Config:<syntaxhighlight lang=bash>nano /etc/pve/qemu-server/**YOUR-WINDOWS-VM-ID**.conf</syntaxhighlight>And add the following arguments to the args: line. If the args: line doesn't exist, create it at the top of 1920x1080 (1080p)the config.<syntaxhighlight lang=bash>-device ivshmem-plain,memdev=ivshmem,bus=pcie.0 -object memory-backend-file,id=ivshmem,share=on,mem-path=/dev/shm/looking-glass,size=32M -device virtio-mouse-pci -device virtio-keyboard-pci -spice 'addr=0.0.0.0,port=[spice port],disable-ticketing=on' -device virtio-serial-pci -chardev spicevmc,id=vdagent,name=vdagent -device virtserialport,chardev=vdagent,name=com.redhat.spice.0</syntaxhighlight>The -device virtio-mouse-pci -device virtio-keyboard-pci are not strictly necessary but should reduce input latency.

<pre style="white-space: pre-wrap; white-space: -moz-pre-wrap; white-space: -pre-wrap; white-space: -o-pre-wrap; word-wrap: break-word;">1920 x 1080 x 4 x 2 = 16,588,800 bytes16,588,800 / 1024 / 1024 = 15[spice port] should be replaced by a tcp port not in use.82 MB + 2 = 17.82</pre>

You must round this value up to Boot the nearest power of two, which with the above example would be 32MBWindows VM

It is suggested that you create the shared memory file before starting the === Linux VM with the appropriate permissions for your system, this only needs to be done once at boot time, for example (this is a sample script only, do not use this without altering it for your requirements):setup ===

In a shell to the Proxmox host edit the Linux VM Config:<codesyntaxhighlight lang=bash>touch nano /devetc/pve/shmqemu-server/looking**YOUR-LINUX-VM-glass && chown userID**.conf</syntaxhighlight>And add the arguments to the args: line. If the args:kvm line doesn't exist, create it at the top of the config. <syntaxhighlight lang=bash>-device ivshmem-plain,memdev=ivshmem,bus=pcie.0 -object memory-backend-file,id=ivshmem,share=on,mem-path=/dev/shm/looking-glass && chmod 660 ,size=32M</devsyntaxhighlight>Then boot the Linux VM, and download the latest Looking-glass source from https:/shm/looking-glass<.io/code>downloads (Tested with version B5.0.1)

== Follow the Official Looking -glass documentation on how to Build Looking-Glass Service (Windows) ==Client - https://looking-glass.io/docs/B5.0.1/build/#building

You must first run Follow the Windows VM with Official Looking-glass documentation on how to install the changes noted above in either the [[Installation#libvirt_Configuration|libvirt]] or [[Installation#Qemu_Commands|Qemu]] sectionskernel module - https://looking-glass.io/docs/B5.0.1/module/

=== Installing the IVSHMEM Driver Running Looking-Glass ===----Windows will not prompt for a driver for the IVSHMEM device, instead, it will use a default null (do nothing) driver for the device. To install the IVSHMEM driver you will need to go into the device manager and update the driver for the device "PCI standard RAM Controller" under the "System Devices" node.

A signed Windows 10 driver can be obtained from Red Hat for this device from # Make sure both VMs are running.# On the below addressLinux VM, open a terminal and cd to the looking glass client build folder# Run Looking-Glass with:<syntaxhighlight lang=bash> ./looking-glass-client -f /dev/kvmfr0 -c **Your_Proxmox_Host_IP** -p **spice port specified**</syntaxhighlight>

Please note that you must obtain version 0This currently only work for Windows guest, as Looking Glass Linux Host is immature at the moment.1.161 or later

=== Using You can simplify the guest set up by replacing the IVSHMEM settings in <code>args</code> with the Windows Host Application =following line:<syntaxhighlight lang=bash>ivshmem: size= 32</syntaxhighlight>This will create a 32M IVSHMEM file under <code>/dev/shm/pve-shm---{{**VMID**</code>. You will need to point <code>app:Windows_Host_Application}}shmFile</code> to this file when launching LG client.

If you want to run a Linux VM with GPU passthrough, but also being able to LG into this Windows guest in addition to from Proxmox host, you can add the following line in VM config file:<syntaxhighlight lang=bash>ivshmem: size= Running 32,name=**WINDOWS-VMID**</syntaxhighlight>This will override Proxmox to open <code>/dev/shm/pve-shm-**name**</code> instead, and since the Client ==default for **name** is **VMID**, set that to your Windows's VMID does the trick.

The client command is the binary Additionally you can use UNIX socket for SPICE instead of opening another port on Proxmox. This file: cannot be accessed by Linux guest so only do this if you don'''lookingt need access Looking Glass from another VM.<syntaxhighlight lang=bash>-spice unix=on,addr=/run/lg**YOUR-WINDOWS-glassVM-client'''. This command should run after the Windows Host Application has startedID**. socket,disable-ticketing=on</syntaxhighlight>

For an updated list of arguments visit:https://githubHowever, those 2 files will be created as root-owned.comYou will need to create a hook script to set the correct permissions for them (/gnifetc/LookingGlass/blob/master/client/READMEtmpfile.md d was having reliability issue on my machine for IVSHMEM file, and it cannot override socket file's ownership at all):

Common options include '-s' for disabling spice<syntaxhighlight lang=bash># 3rd party script, '-S' for disabling created by the screen savercommunity, 'not part of Looking Glass project!# Assuming you have set up a storage named `local-F' to automatically enter full screen btrfs` and 'is mounted at `/var/lib/pve/local-k' to disable the UPSbtrfs`wget https://github.com/MakiseKurisu/single-node-homelab/raw/c6daee9c242571977a0af9088c4d7360dd309685/ansible/proxmox-init/pve-helper -O /var/lib/pve/local-btrfs/snippets/pve-helperchmod +x /var/lib/pve/local-btrfs/snippets/pve-helperqm set $VMID --hookscript=local-btrfs:snippets/pve-helperecho "#lg-chown user" >> /etc/pve/qemu-server/FPS rate$VMID.conf</syntaxhighlight>