Changes

This guide will step you through building the The [https://looking -glass client on .io/docs/stable/install Official Documentation] contains installation instructions for Debian -based systems from sourcedistributions 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 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 zypper install make cmake binutils-devel SDL2make cmake fontconfig-devel SDL2_ttflibSDL2-devel nettlelibSDL2_ttf-devel spice-protocol fontconfig-devel libX11-devel egllibnettle-devel wayland-devel waylandprotocols-devel mesa-libGLU\ libconfig-devel mesa-libGLESlibXi-devel mesa-libGLlibXss-devel mesalibwayland-libEGLegl-develnettle

===== OpenSuSE Leap 15.0+ ==Tumbleweed === For Tumbleweed this should do the trick:

zypper install make in binutils-devel clang cmake binutilsdejavu-sans-mono-fonts fontconfig-devel gcc gcc-c++ glibc-all-langpacks libdecor-devel libglvnd-devel libnettle-devel libpulse-devel libsamplerate-devel libSDL2-devel libSDL2_ttf-devel libnettlelibvulkan1 libwayland-egl-devel libxkbcommon-devel libXpresent-devel libXrandr-devel libXScrnSaver-devel libXss-devel make Mesa-libGLESv3-devel nettle -devel pipewire-devel pkgconf-pkg-config pkgconfig spice-protocol-devel fontconfigvulkan-devel libX11loader wayland-devel libconfigzlib-devel libwayland-egl-develstatic

==== Downloading ==Arch Linux / Manjaro ==

Either visit the site at [https://looking=== 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 nettle pkgconf binutils \ libxi libxinerama libxss libxcursor libxpresent libxkbcommon wayland-protocols \ ttf-glass.hostfission.comdejavu libsamplerate</downloads Looking Glass Download Page]syntaxhighlight> === Installing Additional Dependencies for Kernel Module Build ===

==Void Linux == Building  ===Installing Dependencies === <!-- Dependencies must match Debian's order, and extra dependencies must be on another line, 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>

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. <pre style="white-space: pre-wrap; white-space: -moz-pre-wrap; white-space: -pre-wrap; white-space: -o-pre-wrap; word-wrap: break-word;">mkdir buildcd buildcmake ../make</pre>= Gentoo ==

;NOTE=== Installing Dependencies ===First set up the necessary USE flags if needed: The most common compile error is related to backtrace support this can <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 disabled by adding the following option to the on another line, with a consistent order --><syntaxhighlight lang=bash>emerge sys-devel/binutils dev-util/cmake command. '''media-fonts/freefonts media-libs/libsdl2 media-libs/sdl2-ttf app-emulation/spice-protocol \ media-libs/fontconfig dev-libs/nettle media-libs/libsamplerate \ media-DENABLE_BACKTRACElibs/glu</syntaxhighlight>This list can also be placed into a setfile in /etc/portage/sets/ so that they can be updated with <syntaxhighlight lang=0'''. bash>emerge @setfile</syntaxhighlight>

=== libvirt Configuration Prerequisites ===----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.

* A working Proxmox install on a computer with 2 GPU'''If you are using QEMU directly, this does not apply to yous (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)* Proxmox Host Installed and running on the Windows VM

Add the following to the libvirt machine configuration inside the During Proxmox 7 lifecycle they shipped a newer OVMF firmware than tested, and breaks '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-glasskvmfr'> <model type='ivshmem-plain'/> <size unit='M'>32</size></shmem></pre>module. Currently the workaround is to use an older version of it:

The memory size (show as 32 in the example above may need to be adjusted as per [[Installation#Determining_Memory|Determining Memory]] section apt install pve-edk2-firmware=3.20220526-1 apt-mark hold pve-edk2-firmware

=== Qemu Commands ===----Add the following to the commands to your QEMU command lineFor Proxmox 8, adjusting the bus to suit your particular configuration: <pre style="whitecurrent 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;">-device ivshmem-plain,memdev=ivshmem,bus=pcie4 is tested to work with kvmfr 0.0 \-object memory-backend-file.9 with Linux 6.4.3 in Linux VM. If you used the workaround mentioned above,id=ivshmem,share=on,mem-path=/dev/shm/looking-glass,size=32M</pre>you can revert it by:

=== Determining Memory Windows VM setup ===----You will need to adjust the memory size to a value that is suitable for your desired maximum resolution using the following formula:

Using the Proxmox GUI, Set the Windows VM Display to "none" Then in a shell to the Proxmox host edit the Windows VM Config:<pre stylesyntaxhighlight lang="whitebash>nano /etc/pve/qemu-server/**YOUR-WINDOWS-VM-spaceID**.conf</syntaxhighlight>And add the following arguments to the args: preline. 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-wrap; whitepath=/dev/shm/looking-glass,size=32M -space: device virtio-mozmouse-prepci -wrap; whitedevice virtio-space: keyboard-prepci -wrap; whitespice 'addr=0.0.0.0,port=[spice port],disable-space: ticketing=on' -odevice virtio-preserial-wrap; wordpci -wrap: breakchardev spicevmc,id=vdagent,name=vdagent -word;">width x height x 4 x 2 device virtserialport,chardev= total bytestotal bytes / 1024 / 1024 vdagent,name= total megabytes + 2com.redhat.spice.0</presyntaxhighlight>The -device virtio-mouse-pci -device virtio-keyboard-pci are not strictly necessary but should reduce input latency.

For example, for [spice port] should be replaced by a resolution of 1920x1080 (1080p)tcp port not in use.

It is suggested that you create In a shell to the shared memory file before starting Proxmox host edit the Linux VM with Config:<syntaxhighlight lang=bash>nano /etc/pve/qemu-server/**YOUR-LINUX-VM-ID**.conf</syntaxhighlight>And add the arguments to the args: line. If the appropriate permissions for your systemargs: line doesn't exist, this only needs to be done once 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,size=32M</syntaxhighlight>Then boot timethe Linux VM, for example and download the latest Looking-glass source from https://looking-glass.io/downloads (this is a sample script only, do not use this without altering it for your requirementsTested with version B5.0.1):

<code>touch /dev/shm/lookingFollow the Official Looking-glass && chown userdocumentation on how to Build Looking-Glass Client - https:kvm /dev/shm/looking-glass && chmod 660 .io/devdocs/shmB5.0.1/looking-glass<build/code>#building

== Follow the Official Looking Glass Service (Windows) ==-glass documentation on how to install the kernel 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 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>