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 --==== Build Dependancies ====!

* 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+ ==

=== Installing Dependencies for Client Build === <!-- Dependencies must match Debian's order, and extra dependencies must be on another line, with a consistent order --><codesyntaxhighlight lang=bash> aptdnf install cmake gcc gcc-c++ libglvnd-devel fontconfig-devel spice-protocol make nettle-get install devel \ pkgconf-pkg-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</codesyntaxhighlight >

<syntaxhighlight lang===== OpenSuSE Leap 15.0+ =====bash>dnf install pipewire-devel libsamplerate-devel</syntaxhighlight>

PulseAudio users:<codesyntaxhighlight lang=bash>zypper dnf install make cmake binutils-devel libSDL2-devel libSDL2_ttf-devel libnettle-devel nettle spice-protocol-devel fontconfig-devel libX11pulseaudio-devel libconfiglibs-devel libwayland-egllibsamplerate-devel</codesyntaxhighlight>

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

Either visit the site at [https://looking<syntaxhighlight lang=bash>dnf install dkms kernel-devel kernel-glass.hostfission.comheaders</downloads Looking Glass Download Page]syntaxhighlight >

Or pull the lastest using the '''git''' command== OpenSuSE Leap 15.<code>git clone https://github.com/gnif/LookingGlass.git</code>0+ ==

==== Building Installing Dependencies === <!-- Dependencies must match Debian's order, and extra dependencies must be on another line, with a consistent order --><syntaxhighlight lang=bash>zypper install binutils-devel make cmake fontconfig-devel libSDL2-devel libSDL2_ttf-devel spice-protocol-devel libX11-devel libnettle-devel wayland-protocols-devel \ libconfig-devel libXi-devel libXss-devel libwayland-egl-devel nettle</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>== Tumbleweed ===

Should For Tumbleweed this all go well you should be left with do the file '''looking-glass-client'''. Before you run the client you will first need to configure either Libvirt or Qemu (whichever you prefer) and then setup the Windows side service.trick:

=== libvirt Configuration Installing Dependencies for Client Build === <!--Dependencies must match Debian's order, and extra dependencies must be on another line, with a consistent order --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 stylesyntaxhighlight lang="white-space: pre-wrap; white-space: -moz-pre-wrap; white-space: -pre-wrap; white-space: -o-pre-wrap; bash>wordpacman -wrap: breakSyu cmake gcc libgl libegl fontconfig spice-word;">protocol make nettle pkgconf binutils \<shmem name='looking libxi libxinerama libxss libxcursor libxpresent libxkbcommon wayland-glass'>protocols \ <model type='ivshmem ttf-plain'/> <size unit='M'>32</size></shmem>dejavu libsamplerate</presyntaxhighlight>

=== Qemu Commands ===----Add the following to the commands to your QEMU command line, adjusting the bus to suit your particular configuration: <pre stylesyntaxhighlight lang="white-space: pre-wrap; white-space: -moz-pre-wrap; white-space: -pre-wrap; white-space: -o-pre-wrap; word-wrap: break-word;"bash>pacman -device ivshmem-plain,memdev=ivshmem,bus=pcie.0 \Syu dkms linux-object memory-backend-file,id=ivshmem,share=on,mem-path=/dev/shm/looking-glass,size=32Mheaders</presyntaxhighlight >

The memory size (show as 32 in the example above may need to === Installing Dependencies === <!-- Dependencies must match Debian's order, and extra dependencies must be adjusted as per [[Installation#Determining_Memory|Determining Memory]] section.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>

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

=== Installing Dependencies ===First set up the necessary USE flags if needed:<pre stylesyntaxhighlight lang=bash>echo "whitemedia-spacelibs/libsdl2 gles2" >> /etc/portage/package.use/libsdl2echo "media-libs/nettle gmp" >> /etc/portage/package.use/nettle</syntaxhighlight>Then fetch the packages: pre-wrap; white <!-space: -mozDependencies must match Debian's order, and extra dependencies must be on another line, with a consistent order -pre-wrap; >white<syntaxhighlight lang=bash>emerge sys-devel/binutils dev-space: util/cmake media-prefonts/freefonts media-wrap; whitelibs/libsdl2 media-space: libs/sdl2-ottf app-preemulation/spice-wrap; protocol \word media-libs/fontconfig dev-libs/nettle media-wrap: breaklibs/libsamplerate \ media-word;"libs/glu</syntaxhighlight>width x height x 4 x 2 = total bytestotal bytes This list can also be placed into a setfile in /etc/portage/ 1024 sets/ 1024 so that they can be updated with <syntaxhighlight lang= total megabytes + 2bash>emerge @setfile</presyntaxhighlight>

<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.82 MB + 2 Prerequisites === 17.82</pre>

You must round this value up to the nearest power of two, which * 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)* Proxmox Host Installed and running on the above example would be 32MBWindows VM

It During Proxmox 7 lifecycle they shipped a newer OVMF firmware than tested, and breaks '''kvmfr''' module. Currently the workaround is suggested that you create the shared memory file before starting the 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 an older version of it for your requirements):

<code> apt install pve-edk2-firmware=3.20220526-1touch /dev/shm/looking apt-glass && chown user:kvm /dev/shm/lookingmark hold pve-glass && chmod 660 /dev/shm/lookingedk2-glass</code>firmware

apt-mark unhold pve-edk2-firmware apt full-upgrade === Windows VM setup === Using the Proxmox GUI, Set the Windows VM Display to "none" 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=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. [spice port] should be replaced by a tcp port not in use. Boot the Windows VM === Linux VM setup === In a shell to the Proxmox host edit the Linux VM 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 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=/dev/shm/looking-glass,size=32M</syntaxhighlight>Then boot the Linux VM, and download the latest Looking-glass source from https://looking-glass.io/downloads (Tested with version B5.0.1) Follow the Official Looking-glass documentation on how to Build Looking-Glass Client - https://looking-glass.io/docs/B5.0.1/build/#building Follow the Official Looking-glass documentation on how to install the kernel module - https://looking-glass.io/docs/B5.0.1/module/ === Running Looking-Glass === # Make sure both VMs are running.# On the Linux 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> === Using vGPU merged driver to run Looking Glass on Proxmox Host === 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's VMID does the Client 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't need access Looking Glass from another VM.<syntaxhighlight lang=bash>-spice unix=on,addr=/run/lg**YOUR-WINDOWS-VM-ID**.socket,disable-ticketing=on</syntaxhighlight> However, those 2 files will be created as root-owned. 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's ownership at all): <syntaxhighlight lang=bash># 3rd party script, created by the community, not part of Looking Glass project!# Assuming you have set up a storage named `local-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-server/$VMID.conf</syntaxhighlight>