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
yum dnf install make cmake binutilsdkms kernel-devel SDL2kernel-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 libXfixes-develheaders
===== OpenSuSE Leap 15.0+ =====
Either visit the site at [https://looking-glass.hostfission.com/downloads Looking Glass Download Page]=== Prerequisites ===
Or pull the lastest * A working Proxmox install on a computer with 2 GPU'''bleedings (Tested with 7.1-6)* A Windows VM with GPU pass-through working (Tested with Win 10)* A Linux VM with GPU pass-edge version''' using through working (Tested With Ubuntu 21.10)* Proxmox Host Installed and running on the '''git''' command.Windows VM
<syntaxhighlight lang apt install pve-edk2-firmware=bash>3.20220526-1git clone apt-mark hold pve-edk2-recursive https://github.com/gnif/LookingGlass.git</syntaxhighlight >firmware
==== Building ====For Proxmox 8, the current pve-edk2-firmware version 3.20230228-4 is tested to work with kvmfr 0.0.9 with Linux 6.4.3 in Linux VM. If you used the workaround mentioned above, you can revert it by:
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. apt-mark unhold pve-edk2-firmware<syntaxhighlight lang=bash>mkdir client/buildcd client/buildcmake ../make</syntaxhighlight> apt full-upgrade
;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 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.== Windows VM setup ===
Should this all go well you should be left with Using the file '''looking-glass-client'''. Before you run Proxmox GUI, Set the client you will first need Windows VM Display to configure either Libvirt or Qemu (whichever you prefer) and then set up the Windows side service."none"
You can call Then in a shell to the client from Proxmox host edit the build directory; or, you can make it callable generally by adding the directory to your path or issuing Windows VM Config:
ln nano /etc/pve/qemu-s $(pwd)server/looking**YOUR-WINDOWS-glassVM-client /usr/local/bin/ID**.conf
from the build directory. === 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. '''If you are using QEMU directly, this does not apply to you.''' Add And add the following arguments to the libvirt machine configuration inside args: line. If the args: line doesn'devices' section by running "virsh edit VM" where VM is t exist, create it at the name top of your virtual machinethe config.<syntaxhighlight lang=xmlbash><shmem name-device ivshmem-plain,memdev=ivshmem,bus='lookingpcie.0 -object memory-backend-glass'> <model typefile,id='ivshmem,share=on,mem-plain'path=/dev/shm/> <looking-glass,size unit=32M -device virtio-mouse-pci -device virtio-keyboard-pci -spice 'Maddr=0.0.0.0,port=[spice port],disable-ticketing=on'>32</size></shmem>-device virtio-serial-pci -chardev spicevmc,id=vdagent,name=vdagent -device virtserialport,chardev=vdagent,name=com.redhat.spice.0
The memory size (show as 32 in the example above may need to be adjusted as per [[Installation#Determining_Memory|Determining Memoryspice port]] sectionshould be replaced by a tcp port not in use.
If you use AppArmor (which is enabled by default on Ubuntu), you will also need to add permission for qemu to access Boot the memory file in apparmor. This can be done by adding '/dev/shm/looking-glass rw,' to the /etc/apparmor.d/abstractions/libvirt-qemu fileWindows VM
If you would like to use Spice to give you keyboard and mouse input along with clipboard sync support be sure to also do the following:=== Linux VM setup ===
* Add In a QXL video device, but in shell to the type field type `none` (on older libvirt versions just disable Proxmox host edit the device in Windows Device Manager)Linux VM Config:<syntaxhighlight lang=bash>nano /etc/pve/qemu-server/**YOUR-LINUX-VM-ID** Be sure .conf</syntaxhighlight>And add the arguments to remove the virtual tablet pointing args: line. If the args: line doesn't exist, create it at the top of the config. <syntaxhighlight lang=bash>-deviceivshmem-plain,memdev=ivshmem,bus=pcie.0 -object memory-backend-file,id=ivshmem,share=on,mem-path=/dev/shm/looking-glass,size=32M</syntaxhighlight>* Be sure to add Then boot the virtual PS/2 Mouse deviceLinux VM, and download the Virtio keyboard devicelatest Looking-glass source from https://looking-glass.* Be sure that there is also a Spice Display configured io/downloads (in addition to the video deviceTested with version B5.0.1) If you want clipboard synchronization please see [[FAQ#How to enable clipboard synchronization via SPICE]]
Add # Make sure both VMs are running.# On the following Linux VM, open a terminal and cd to the commands to your QEMU command line, adjusting the bus to suit your particular configurationlooking glass client build folder# Run Looking-Glass with:
-device ivshmem-plain,memdev=ivshmem,bus=pcie .0 \/looking-object memory-backendglass-file,id=ivshmem,share=on,memclient -path=f /dev/shm/lookingkvmfr0 -c **Your_Proxmox_Host_IP** -glass,size=32Mp **spice port specified**
The memory size (show as 32 in the example above may need === Using vGPU merged driver to be adjusted as per [[Installation#Determining_Memory|Determining Memory]] section.run Looking Glass on Proxmox Host ===
=== Determining Memory ===----You will need to adjust the memory size to a value that This currently only work for Windows guest, as Looking Glass Linux Host is suitable for your desired maximum resolution using immature at the following formula:moment.
For exampleIf 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 a resolution of 1920x1080 (1080p)**name** is **VMID**, set that to your Windows's VMID does the trick.
<code>1920 x 1080 x 4 x 2 = 16,588,800 bytes16,588,800 / 1024 / 1024 = 15Additionally you can use UNIX socket for SPICE instead of opening another port on Proxmox.82 MB + 2 = 17.82</code> You must round this value up to the nearest power of two, which with the above example would be 32MB It is suggested that you create the shared memory This file before starting the VM with the appropriate permissions for your system, this only needs to cannot be done once at boot time, for example (this is a sample script accessed by Linux guest so only, do not use this without altering it for your requirements): <code>touch /dev/shm/looking-glass && chown user:kvm /dev/shm/looking-glass && chmod 660 /dev/shm/looking-glass</code> == if you don't need access Looking Glass Service (Windows) == You must first run the Windows from another VM with the changes noted above in either the [[Installation#libvirt_Configuration|libvirt]] or [[Installation#Qemu_Commands|Qemu]] sections. === Installing the IVSHMEM Driver ==<syntaxhighlight lang=bash>----Windows will not prompt for a driver for the IVSHMEM devicespice unix=on, 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. '''French:''' "Gestionnaire de périphérique" -> "Périphériques Système" -> "Contrôleur de RAM Standard PCI" A signed Windows 10 driver can be obtained from Red Hat for this device from the below address: https:addr=/run/fedorapeople.org/groups/virt/virtio-win/directlg**YOUR-downloads/upstreamWINDOWS-virtio/ Please note that you must obtain version 0.1.161 or later ==== A note about IVSHMEM and Scream Audio ====Using IVSHMEM with Scream may interfere with Looking Glass as it may try to use the same device. Please do not use the IVSHMEM plugin for Scream. Use the default network transfer method. 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 one. 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-glass-hostID**.ini file in the same directory as the lookingsocket,disable-glass-host.exe file. In it, you can use the os:shmDevice option like so: <syntaxhighlight langticketing=INI>[os]shmDevice=1on
=== Using the Windows Host Application === However, those 2 files will be created as root----Start downloading owned. You will need to create a hook script to set the correct version permissions for your release from https:them (/etc/looking-glasstmpfile.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. ''d was having reliability issue on my machine for IVSHMEM file, and it cannot override socket file'Notes ownership at all):''' If your '''looking-glass-client''' was created by building from the '''master branch''' you have to pick the '''Bleeding Edge''' version.
The windows host application captures the windows desktop and stuffs <syntaxhighlight lang=bash># 3rd party script, created by the frames into the shared memory via the shared memory virtual devicecommunity, without this not part of 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.project! To get the Windows-Host-Application running after restart # Assuming you need to run it as have set up a privileged task we do that by starting '''cmd.exe''' as '''administrator''' storage named `local-btrfs` and running a command in it which creates a windows task.is mounted at `/var/lib/pve/local-btrfs` '''Notewget https:''' At this time the Looking Glass host does not support running under unprivileged users. Your user account must have administrator privileges for the windows task to function//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-helper<syntaxhighlight langqm set $VMID --hookscript=batch>local-btrfs:snippets/pve-helperSCHTASKS /Create /TN echo "Looking Glass#lg-chown user" >> /SC ONLOGON etc/RL HIGHEST pve/TR C:\Users\<YourUserName>\<YourPath>\lookingqemu-glass-hostserver/$VMID.execonf
Copy the following command in 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")''' .
[[File:Screenshot_cmd_windowstask.png|500px]]
Now you simply need to hit enter in to the cmd shell and restart the vm to test if it worked.
== Running the Client ==
The client command is the binary file: '''looking-glass-client'''. This command should run after the Windows Host Application has started.
For an updated list of arguments visit:
https://github.com/gnif/LookingGlass/blob/master/client/README.md
Common options include '-s' for disabling spice, '-S' for disabling the screen saver, '-F' to automatically enter full screen and '-k' to disable the UPS/FPS rate.
→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 >
For audio support in Bleeding Edge, the following packages should also be installed: PipeWire users: <syntaxhighlight lang=bash>dnf install pipewire-devel libsamplerate-devel</syntaxhighlight> PulseAudio users:<syntaxhighlight lang=bash>dnf install pulseaudio-libs-devel libsamplerate-devel</syntaxhighlight> === Fedora 29+ ==Installing Additional Dependencies for Kernel Module Build ===
<syntaxhighlight lang=bash>
</syntaxhighlight >
=== 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 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-devel libXi-develnettle
</syntaxhighlight >
===== Arch / Manjaro ==Tumbleweed === For Tumbleweed this should do the trick:
<syntaxhighlight lang=bash>
zypper 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</syntaxhighlight > == Arch Linux / Manjaro == === 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 binutils sdl2 sdl2_ttf libx11 nettle cmake gcc libgl libegl fontconfig cmake spice-protocol gnumake nettle pkgconf binutils \ libxi libxinerama libxss libxcursor libxpresent libxkbcommon wayland-freeprotocols \ ttf-fontsdejavu libsamplerate
</syntaxhighlight>
===Installing Additional Dependencies for Kernel Module Build == Void Linux = <syntaxhighlight lang=bash>pacman -Syu dkms linux-headers</syntaxhighlight > ==Void Linux ==
=== 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 fontconfiglibX11-devel libXpresent-devel libX11libXinerama-devel nettle-devel\ gcc make pkg-config
</syntaxhighlight>
==Gentoo == = Gentoo ==Installing Dependencies ===
First set up the necessary USE flags if needed:
<syntaxhighlight lang=bash>
echo "media-libs/libsdl2 glesgles2" >> /etc/portage/package.use/libsdl2
echo "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 devapp-libsemulation/nettle spice-protocol \ media-libs/fontconfig dev-utillibs/cmake app-emulation/spice-protocol nettle media-fontslibs/freefonts 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>
==== Downloading ==Proxmox ==
During Proxmox 7 lifecycle they shipped a newer OVMF firmware than tested, and breaks '''Note: If you are using the latest bleeding-edge from the master branch you MUST download/use the corresponding host applicationkvmfr'''module. Currently the workaround is to use an older version of it:
<syntaxhighlight lang=bash>
</syntaxhighlight>
</syntaxhighlight>
The -device virtio-mouse-pci -device virtio-keyboard-pci are not strictly necessary but should reduce input latency.
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/
=== Qemu Commands Running Looking-Glass ===----'''If you are using virt manager then this does not apply to you.'''
<syntaxhighlight lang=bash>
</syntaxhighlight>
You can simplify the guest set up by replacing the IVSHMEM settings in <code>args</code> with the following line:width x height x 4 x 2 <syntaxhighlight lang= total bytesbash>total bytes ivshmem: size=32</ 1024 syntaxhighlight>This will create a 32M IVSHMEM file under <code>/dev/shm/pve-shm-**VMID**</ 1024 = total megabytes + 2code>. You will need to point <code>app:shmFile</code>to this file when launching LG client.
</syntaxhighlight>
</syntaxhighlight>
