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-libGLU-devel mesa-libGLES-devel mesa-libGL-devel mesa-libEGL-devel g++</syntaxhighlight > ===== OpenSuSE Leap 15.0+ =====
zypper dnf install make cmake binutilspulseaudio-devel libSDL2-devel libSDL2_ttf-devel libnettle-devel nettle spice-protocol-devel fontconfig-devel libX11-devel libconfig-devel libwayland-egllibs-devel libXilibsamplerate-devel</syntaxhighlight >
pacman dnf install dkms kernel-Syu binutils sdl2 sdl2_ttf libx11 nettle fontconfig cmake spicedevel kernel-protocol gnu-free-fontsheaders</syntaxhighlight>
xbps-zypper install -Syu binutils-devel make cmake freefontfontconfig-ttf SDL2devel libSDL2-devel SDL2_ttflibSDL2_ttf-devel spice-protocol fontconfig-devel libX11-devel nettlelibnettle-devel wayland-protocols-devel \ libconfig-devel libXi-devel libXss-devel libwayland-egl-develnettle</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 zypper in binutils-devel clang cmake dejavu-recursive https://github.com/gnif/LookingGlass.gitsans-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 ==
If you would like to use Spice to give you keyboard and mouse input along with clipboard sync support be sure to also do === Installing Dependencies ===First set up the followingnecessary USE flags if needed:<syntaxhighlight lang=bash>* Add a QXL video device, but in the type field type `none` (on older libvirt versions just disable the device in Windows Device Manager)echo "media-libs/libsdl2 gles2" >> /etc/portage/package.use/libsdl2* Be sure to remove the virtual tablet pointing deviceecho "media-libs/nettle gmp" >> /etc/portage/package.use/nettle</syntaxhighlight>* Be sure to add Then fetch the virtual PS/2 Mouse devicepackages: <!-- Dependencies must match Debian's order, and the Virtio keyboard device.* Be sure that there is also extra dependencies must be on another line, with a Spice Display configured (in addition to the video device)consistent order --> If you want clipboard synchronization please see [[FAQ#How to enable clipboard synchronization via SPICE]] === Qemu Commands ==<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 \'''If you are using virt manager then this does not apply to you.''' media-libs/glu</syntaxhighlight>Add the following to the commands to your QEMU command line, adjusting the bus to suit your particular configuration: This list can also be placed into a setfile in /etc/portage/sets/ so that they can be updated with
-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.
'''French:''' "Gestionnaire de périphérique" -> "Périphériques Système" -> "Contrôleur de RAM Standard PCI"Boot the Windows VM
A signed Windows 10 driver can be obtained from Red Hat for this device from the below address:=== Linux VM setup ===
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
==== A note about IVSHMEM and Scream Audio ====Using IVSHMEM with Scream may interfere with Follow the Official Looking Glass as it may try -glass documentation on how to use the same device. Please do not use install the IVSHMEM plugin for Screamkernel module - https://looking-glass. Use the default network transfer methodio/docs/B5. The IVSHMEM method induces additional latency that is built into its implementation. When using VirtIO for a network device the VM is already using a highly optimized memory copy anyway so there is no need to make another one0.1/module/
If you insist on using IVSHMEM for Scream despite it's inferiority to the default network implementation the Windows Host Application can be told what device to use. Create a looking=== Running Looking-glass-host.ini file in the same directory as the looking-glass-host.exe file. In it, you can use the os:shmDevice option like so:Glass ===
The windows host application captures the windows desktop and stuffs the frames into the shared memory via the shared memory virtual deviceThis currently only work for Windows guest, without this as Looking Glass will not function. It Linux Host is critical that the version of the host application matches immature at the version of the client application, as differing versions can be, and usually are, incompatiblemoment.
To get You can simplify the Windows-Host-Application running after restart you need to run it as a privileged task we do that guest set up by starting '''cmd.exe''' as '''administrator''' and running a command replacing the IVSHMEM settings in it which creates a windows task.<code>args</code> with the following line:<syntaxhighlight lang=batchbash>SCHTASKS /Create /TN "Looking Glass" /SC ONLOGON /RL HIGHEST /TR Civshmem:\Users\<YourUserName>\<YourPath>\looking-glass-host.exesize=32
Copy 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 command line in VM config file:<syntaxhighlight lang=bash>ivshmem: size=32,name=**WINDOWS-VMID**</syntaxhighlight>This will override Proxmox to your cmd shell and replace the '''open <YourUserNamecode> ''' with your username '''(e.g. "games")''' and your '''/dev/shm/pve-shm-**name**<YourPath/code> ''' with the part where instead, and since the looking-glass-host.exe default for **name** is stored '''(e.g. "Documents")''**VMID**, set that to your Windows' s VMID does the trick.
[[File:Screenshot_cmd_windowstaskAdditionally you can use UNIX socket for SPICE instead of opening another port on Proxmox.png|500px]]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>
Now you simply However, those 2 files will be created as root-owned. You will need to hit enter in create a hook script to set the cmd shell correct permissions for them (/etc/tmpfile.d was having reliability issue on my machine for IVSHMEM file, and restart the vm to test if it worked.cannot override socket file's ownership at all):
→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>
PulseAudio users:
<syntaxhighlight lang=bash>
===== Arch / Manjaro ==Installing Additional Dependencies for Kernel Module Build ===
<syntaxhighlight lang=bash>
===== Void Linux ===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>
<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:
# 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=INIbash>[os]shmDevice=1 ./looking-glass-client -f /dev/kvmfr0 -c **Your_Proxmox_Host_IP** -p **spice port specified**
</syntaxhighlight>
=== Using the Windows vGPU merged driver to run Looking Glass on Proxmox Host Application === ----Start downloading the correct version for your release from https://looking-glass.hostfission.com/downloads. You can either choose between '''Official Releases''' which is is stable or '''Release Candidates''' that tries to be stable but has new features. '''Note:''' If your '''looking-glass-client''' was created by building from the '''master branch''' you have to pick the '''Bleeding Edge''' version.
</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.
<syntaxhighlight lang== Running bash># 3rd party script, created by the Client ==community, not part of Looking Glass project! The client command # Assuming you have set up a storage named `local-btrfs` and is the binary file: '''looking-glassmounted at `/var/lib/pve/local-client'''. This command should run after the Windows Host Application has started. For an updated list of arguments visit:btrfs`wget https://github.com/gnifMakiseKurisu/single-node-homelab/raw/c6daee9c242571977a0af9088c4d7360dd309685/LookingGlassansible/blobproxmox-init/masterpve-helper -O /clientvar/README.md lib/pve/local-btrfs/snippets/pve-helperchmod +x /var/lib/pve/local-btrfs/snippets/pve-helperCommon options include 'qm set $VMID -s' for disabling spice, '-S' for disabling the screen saver, 'hookscript=local-btrfs:snippets/pve-helperecho "#lg-F' to automatically enter full screen and 'chown user" >> /etc/pve/qemu-k' to disable the UPSserver/FPS rate$VMID.conf</syntaxhighlight>
