Changes
Jump to navigation
Jump to search
== Looking Glass Client ==
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->
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
===== Fedora 29+ =====For audio support in Bleeding Edge, the following packages should also be installed: PipeWire users:
yum dnf install make cmake binutilspipewire-devel SDL2libsamplerate-devel SDL2_ttf-devel nettle-devel spice-protocol fontconfig-devel libX11-devel egl-wayland-devel wayland-devel mesa</syntaxhighlight> PulseAudio users:<syntaxhighlight lang=bash>dnf install pulseaudio-libGLUlibs-devel mesa-libGLES-devel mesa-libGL-devel mesa-libEGLlibsamplerate-devel</syntaxhighlight >
zypper dnf install make cmake binutilsdkms kernel-devel libSDL2kernel-devel libSDL2_ttf-devel libnettle-devel nettle spice-protocol-devel fontconfig-devel libX11-devel libconfig-devel libwayland-egl-develheaders
sudo pacman -Syu zypper install binutils-dev devel make cmake fontsfontconfig-freefontdevel libSDL2-ttf libsdl2devel libSDL2_ttf-dev libsdl2devel spice-ttfprotocol-dev libspicedevel libX11-protocoldevel libnettle-devel wayland-protocols-devel \ libconfig-devel libXi-devel libXss-dev bfontconfig1devel libwayland-dev libx11egl-dev devel nettle-dev</syntaxhighlight>
Either visit For Tumbleweed this should do the site at [httpstrick://looking-glass.hostfission.com/downloads Looking Glass Download Page]
Or pull the lastest using the '''git''' command.
git clone https://github.com/gnif/LookingGlass.gitzypper in binutils-devel clang cmake dejavu-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 libvulkan1 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 vulkan-loader wayland-devel zlib-devel-static
If you downloaded the file via the web link then you should have a 'zip=== Installing Dependencies for Client Build === <!-- Dependencies must match Debian' 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 -->
mkdir client/buildpacman -Syu cmake gcc libgl libegl fontconfig spice-protocol make nettle pkgconf binutils \cd client/build libxi libxinerama libxss libxcursor libxpresent libxkbcommon wayland-protocols \cmake ../make ttf-dejavu libsamplerate
;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 == Installing Additional Dependencies 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.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 >
The memory size (show as 32 in the example above may need to be adjusted as per [[Installation#Determining_Memory|Determining Memory]] section.== Gentoo ==
-device ivshmem-plain,memdev=ivshmem,bus=pcie.0 \-object memory-backend-file,id=ivshmem,share=on,mem-path=/dev/shm/looking-glass,size=32Memerge @setfile
The memory size (show as 32 in the example above may need to be adjusted as per [[Installation#Determining_Memory|Determining Memory]] section.== Proxmox ==
<code>* A working Proxmox install on a computer with 2 GPU's (Tested with 7.1-6)width x height x 4 x 2 = total bytes* A Windows VM with GPU pass-through working (Tested with Win 10)total bytes / 1024 / 1024 = total megabytes + 2* A Linux VM with GPU pass-through working (Tested With Ubuntu 21.10)</code>* Proxmox Host Installed and running on the Windows VM
For exampleDuring Proxmox 7 lifecycle they shipped a newer OVMF firmware than tested, for a resolution and breaks '''kvmfr''' module. Currently the workaround is to use an older version of 1920x1080 (1080p)it:
<code>1920 x 1080 x 4 x 2 = 16,588,800 bytes16,588,800 / 1024 / 1024 = 15.82 MB + 2 apt install pve-edk2-firmware= 173.8220220526-1</code> apt-mark hold pve-edk2-firmware
You must round this value up For Proxmox 8, the current pve-edk2-firmware version 3.20230228-4 is tested to the nearest power of two, which work with kvmfr 0.0.9 with Linux 6.4.3 in Linux VM. If you used the workaround mentioned above example would be 32MB, you can revert it by:
It 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 it for your requirements): apt-mark unhold pve-edk2-firmware apt full-upgrade
<code>touch /dev/shm/looking-glass && chown user:kvm /dev/shm/looking-glass && chmod 660 /dev/shm/looking-glass</code>=== Windows VM setup ===
== Looking Glass Service (Using the Proxmox GUI, Set the Windows) ==VM Display to "none"
You must first run Then in a shell to the Proxmox host edit the Windows VM with Config:<syntaxhighlight lang=bash>nano /etc/pve/qemu-server/**YOUR-WINDOWS-VM-ID**.conf</syntaxhighlight>And add the changes noted above in either 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=[[Installation#libvirt_Configuration|libvirt]] or [[Installation#Qemu_Commands|Qemu]spice port] sections,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.
=== Installing the IVSHMEM Driver ===----Windows will [spice port] should be replaced by a tcp port not prompt for a driver for the IVSHMEM device, instead, it will in 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 Boot the Windows 10 driver can be obtained from Red Hat for this device from the below address:VM
https://fedorapeople.org/groups/virt/virtio-win/direct-downloads/upstream-virtio/=== Linux VM setup ===
Please note that you must obtain 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.161 or laterio/docs/B5.0.1/build/#building
=== Using Follow the Windows Host Application === Official Looking-glass documentation on how to install the kernel module ---Start downloading the correct version for your release from https://looking-glass.hostfission.comio/docs/downloads. You can either choose between '''Official Releases''' which is is stable or '''Release Candidates''' that tries to be stable but has new featuresB5. '''Note:''' If your '''looking-glass-client''' was created by building from the '''master branch''' you have to pick the '''Bleeding Edge''' version0.1/module/
The windows host application captures the windows desktop and stuffs the frames into the shared memory via the shared memory virtual device, without this === Running Looking -Glass will not function. It is critical that the version of the host application matches the version of the client application, as differing versions can be, and usually are, incompatible.===
To get # Make sure both VMs are running.# On the Windows-Host-Application running after restart you need to run it as Linux VM, open a privileged task we do that by starting '''cmd.exe''' as '''administrator''' terminal and running a command in it which creates a windows task.cd to the looking glass client build folder# Run Looking-Glass with:<syntaxhighlight lang=batchbash>SCHTASKS /Create /TN "Looking Glass" /SC ONLOGON ./RL HIGHEST /TR C:\Users\<YourUserName>\<YourPath>\looking-glass-host.execlient -f /dev/kvmfr0 -c **Your_Proxmox_Host_IP** -p **spice port specified**
Copy the following command in === Using vGPU merged driver to your cmd shell and replace the '''<YourUserName> ''' with your username '''(e.g. "games")''' and your '''<YourPath> ''' with the part where the looking-glass-host.exe is stored '''(e.g. "Documents")''' .run Looking Glass on Proxmox Host ===
[[File:Screenshot_cmd_windowstaskThis currently only work for Windows guest, as Looking Glass Linux Host is immature at the moment.png|500px]]
Now you simply 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 hit enter in to the cmd shell and restart the vm point <code>app:shmFile</code> to test if it workedthis file when launching LG client.
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>
→Tumbleweed: Add missing xkbcommon dependency (Package 'xkbcommon', required by 'virtual:world', not found)
===== 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 -->
<syntaxhighlight lang=bash>
</syntaxhighlight >
<syntaxhighlight lang=bash>
===== OpenSuSE Leap 15.0+ ==Installing Additional Dependencies for Kernel Module Build ===
<syntaxhighlight lang=bash>
</syntaxhighlight >
===== Arch / Manjaro ===OpenSuSE Leap 15.0+ ==
=== Installing Dependencies ===
<!-- Dependencies must match Debian's order, and extra dependencies must be on another line, with a consistent order -->
<syntaxhighlight lang=bash>
==== Downloading =Tumbleweed ===
<syntaxhighlight lang=bash>
</syntaxhighlight >
==== Building ==Arch Linux / Manjaro ==
<syntaxhighlight lang=bash>
</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.''' 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.with a consistent order --><syntaxhighlight lang=xmlbash><shmem name='lookingxbps-install -Syu binutils-devel cmake freefont-ttf fontconfig-devel SDL2-devel SDL2_ttf-devel spice-protocol libX11-devel libXpresent-devel libXinerama-devel nettle-glass'>devel \ <model type='ivshmem gcc make pkg-plain'/> <size unit='M'>32</size></shmem>config
</syntaxhighlight>
=== Qemu Commands 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---'''If you are using virt manager then this does not apply to youlibs/nettle gmp" >> /etc/portage/package.'''use/nettle</syntaxhighlight>Add Then fetch the following to the commands to your QEMU command packages: <!-- Dependencies must match Debian's order, and extra dependencies must be on another line, adjusting the bus to suit your particular configuration: 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>
</syntaxhighlight>
=== Determining Memory Prerequisites ===----You will need to adjust the memory size to a value that is suitable for your desired maximum resolution using the following formula:
</syntaxhighlight>
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.
