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

==== Downloading =Tumbleweed ===

Either visit For Tumbleweed this should do the site at [httpstrick://looking-glass.hostfission.com/downloads Looking Glass Download Page]

==== Building ==Arch Linux / Manjaro ==

If you downloaded the file via the web link then you should have a 'zip' file. Simply unzip and cd into the new directory. If you used 'git' then cd into the 'LookingGlass' directory. === Installing Dependencies for Client Build === <pre style="white!-space: pre-wrap; whiteDependencies must match Debian's order, and extra dependencies must be on another line, with a consistent order -space: -moz-pre-wrap; ><syntaxhighlight lang=bash>whitepacman -space: Syu cmake gcc libgl libegl fontconfig spice-pre-wrap; protocol make nettle pkgconf binutils \white-space: -o-pre libxi libxinerama libxss libxcursor libxpresent libxkbcommon wayland-wrap; protocols \word ttf-wrap: break-word;">mkdir buildcd buildcmake ../makedejavu libsamplerate</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'''. == Installing Additional Dependencies for Kernel Module Build ===

Should this all go well you should be left with the file '''looking<syntaxhighlight lang=bash>pacman -glassSyu dkms linux-client'''. Before you run the client you will first need to configure either Libvirt or Qemu (whichever you prefer) and then set up the Windows side service.headers</syntaxhighlight >

==Void Linux = 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.

=== Installing Dependencies === <!-- Dependencies must match Debian'''If you are using QEMU directlys order, and extra dependencies must be on another line, this does not apply to you.'''with a consistent order --><syntaxhighlight lang=bash>xbps-install -Syu binutils-devel cmake freefont-ttf fontconfig-devel SDL2-devel SDL2_ttf-devel spice-protocol libX11-devel libXpresent-devel libXinerama-devel nettle-devel \ gcc make pkg-config</syntaxhighlight>

Add the following to the libvirt machine configuration inside the 'devices' section by running "virsh edit VM" where VM is the name of your virtual machine.<pre style="white-space: pre-wrap; white-space: -moz-pre-wrap; white-space: -pre-wrap; white-space: -o-pre-wrap; word-wrap: break-word;"><shmem name='looking-glass'> <model typeGentoo ='ivshmem-plain'/> <size unit='M'>32</size></shmem></pre>

The memory size (show as 32 === Installing Dependencies ===First set up the necessary USE flags if needed:<syntaxhighlight lang=bash>echo "media-libs/libsdl2 gles2" >> /etc/portage/package.use/libsdl2echo "media-libs/nettle gmp" >> /etc/portage/package.use/nettle</syntaxhighlight>Then fetch the packages: <!-- Dependencies must match Debian's order, and 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 the example above may need to /etc/portage/sets/ so that they can be adjusted as per [[Installation#Determining_Memory|Determining Memory]] section.updated with <syntaxhighlight lang=bash>emerge @setfile</syntaxhighlight>

==Proxmox = Qemu Commands ===----Add the following to the commands to your QEMU command line, adjusting the bus to suit your particular configuration: <pre style="white-space: pre-wrap; white-space: -moz-pre-wrap; white-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>

=== Determining Memory ===* A working Proxmox install on a computer with 2 GPU's (Tested with 7.1-6)* A Windows VM with GPU pass-through working (Tested with Win 10)* A Linux VM with GPU pass---through working (Tested With Ubuntu 21.10)You will need to adjust the memory size to a value that is suitable for your desired maximum resolution using * Proxmox Host Installed and running on the following formula:Windows VM

<pre style="white-spaceDuring Proxmox 7 lifecycle they shipped a newer OVMF firmware than tested, and breaks '''kvmfr''' module. Currently the workaround is to use an older version of it: 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>

<pre style="whiteFor Proxmox 8, the current pve-space: preedk2-wrap; whitefirmware version 3.20230228-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 = 15is tested to work with kvmfr 0.0.9 with Linux 6.4.82 MB + 2 = 173 in Linux VM.82</pre>If you used the workaround mentioned above, you can revert it by:

It is suggested that you create the shared memory file before starting the === Windows 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 ===

Then in a 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 the config.<syntaxhighlight lang=bash>-device ivshmem-plain,memdev=ivshmem,bus= Looking Glass Service (Windows) 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.

You must first run the Windows VM with the changes noted above in either the [[Installation#libvirt_Configuration|libvirtspice port]] or [[Installation#Qemu_Commands|Qemu]] sectionsshould be replaced by a tcp port not in use.

=== Installing Boot the IVSHMEM Driver ===----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.VM

httpsIn a shell to the Proxmox host edit the Linux VM Config:<syntaxhighlight lang=bash>nano /etc/pve/qemu-server/fedorapeople**YOUR-LINUX-VM-ID**.orgconf</groupssyntaxhighlight>And add the arguments to the args: line. If the args: 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=/virtdev/virtioshm/looking-winglass,size=32M</directsyntaxhighlight>Then boot the Linux VM, and download the latest Looking-downloadsglass source from https://upstreamlooking-virtioglass.io/downloads (Tested with version B5.0.1)

Please note that you must obtain version Follow the Official Looking-glass documentation on how to Build Looking-Glass Client - https://looking-glass.io/docs/B5.0.1.161 or later/build/#building

=== Using Follow the Windows Host Application === -Official Looking-glass documentation on how to install the kernel module -https://looking-{{:Windows_Host_Application}}glass.io/docs/B5.0.1/module/

=== Running the Client Looking-Glass ===

The # Make sure both VMs are running.# On the Linux VM, open a terminal and cd to the looking glass client command is the binary filebuild folder# Run Looking-Glass with: '''<syntaxhighlight lang=bash> ./looking-glass-client'''. This command should run after the Windows Host Application has started. -f /dev/kvmfr0 -c **Your_Proxmox_Host_IP** -p **spice port specified**</syntaxhighlight>

Common options include This currently only work for Windows guest, as Looking Glass Linux Host is immature at the moment. You can simplify the guest set up by replacing the IVSHMEM settings in <code>args</code> with the 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: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=32,name=**WINDOWS-VMID**</syntaxhighlight>This will override Proxmox to open <code>/dev/shm/pve-shm-**name**</code> instead, and since the default for **name** is **VMID**, set that to your Windows'-sVMID does the trick. 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' for disabling t need access Looking Glass from another VM.<syntaxhighlight lang=bash>-spiceunix=on,addr=/run/lg**YOUR-WINDOWS-VM-ID**.socket,disable-ticketing=on</syntaxhighlight> However, 'those 2 files will be created as root-Sowned. You will need to create a hook script to set the correct permissions for them (/etc/tmpfile.d was having reliability issue on my machine for IVSHMEM file, and it cannot override socket file' for disabling s ownership at all): <syntaxhighlight lang=bash># 3rd party script, 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-btrfs`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-k' to disable the UPSserver/FPS rate$VMID.conf</syntaxhighlight>