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:
dnf zypper install binutils-devel gcc make cmake texlivefontconfig-gnu-freefont SDL2devel libSDL2-devel SDL2_ttflibSDL2_ttf-devel spice-protocol fontconfig-devel libX11-devel nettlelibnettle-devel wayland-protocols-devel \ mesa libconfig-libGLUdevel libXi-devel libXfixeslibXss-devel libXilibwayland-devel waylandegl-develnettle
===== Arch Linux / Manjaro =====
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 Proxmox host edit the Windows VM Config:<syntaxhighlight lang=bash>nano /etc/pve/qemu-server/**YOUR-WINDOWS-VM-ID**.conf</syntaxhighlight>And add the client from following arguments to the build directory; orargs: line. If the args: line doesn't exist, you can make create it callable generally by adding at the directory to your path or issuing top of the config.
ln -s $(pwd)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 -client /usr/local/bin/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
from the build directoryThe -device virtio-mouse-pci -device virtio-keyboard-pci are not strictly necessary but should reduce input latency.
=== libvirt Configuration ===----This article assumes you already have [spice port] should be replaced by a fully functional libvirt VM with PCI Passthrough working on a dedicated monitor. If you do tcp port not please ensure this is configured before you proceedin use.
If you use virt-manager, this guide also applies to you, since it uses libvirt.Boot the Windows VM
'''If you are using QEMU directly, this does not apply to you.'''=== Linux VM setup ===
Add 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 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='M'>32</size></shmem>32M
The memory size (show as 32 in Follow the example above) may need Official Looking-glass documentation on how to be adjusted as per [[InstallationBuild Looking-Glass Client - https://looking-glass.io/docs/B5.0.1/build/#Determining_Memory|Determining Memory]] section.building
==== Spice Server ====If you would like Follow the Official Looking-glass documentation on how to use Spice to give you keyboard and mouse input along with clipboard sync support, make sure you have a <code><graphics type='spice'><install the kernel module - https://looking-glass.io/docs/B5.0.1/module/code> device, then:
* Find your <code><video></code> device, and set <code><model type='none'></code>** If you can't find it, make sure you have a <code><graphics></code> device, save and edit again** On older libvirt versions, just disable the device in Windows Device Manager* Remove the <code><input type='tablet'/></code> device, if you have one* Create an <code><input type='mouse'/></code> device, if you don't already have one* Create an <code><input typeRunning Looking-Glass =='keyboard' bus='virtio'/></code> device to improve keyboard usage** This requires the ''vioinput'' driver from [https://fedorapeople.org/groups/virt/virtio-win/direct-downloads/stable-virtio/ virtio-win] to be installed in the guest
If you want clipboard synchronization please see [[FAQ#How Make sure both VMs are running.# On the Linux VM, open a terminal and cd to enable clipboard synchronization via SPICE]]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>
=== Qemu Commands ===----'''If you are using virt manager/libvirt then this does not apply to youThis currently only work for Windows guest, as Looking Glass Linux Host is immature at the moment.'''
Add You can simplify the guest set up by replacing the IVSHMEM settings in <code>args</code> with the following to the commands to your QEMU command line, adjusting the bus to suit your particular configuration:
-device ivshmem-plain,memdev=ivshmem,bus=pcie.0 \-object memory-backend-file,id=ivshmem,share=on,mem-path=/dev/shm/looking-glass,: size=32M32
The memory 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 (show as =32 in ,name=**WINDOWS-VMID**</syntaxhighlight>This will override Proxmox to open <code>/dev/shm/pve-shm-**name**</code> instead, and since the example above) may need default for **name** is **VMID**, set that to be adjusted as per [[Installation#Determining_Memory|Determining Memory]] sectionyour Windows's VMID does the trick.
=== Determining Memory ===----You will need to adjust the memory size to a value that is suitable Additionally you can use UNIX socket for your desired maximum resolution using the following formula: <code>width x height x 4 x 2 = total bytestotal bytes / 1024 / 1024 = total megabytes + 2</code> For example, for a resolution SPICE instead of 1920x1080 (1080p) <code>1920 x 1080 x 4 x 2 = 16,588,800 bytes16,588,800 / 1024 / 1024 = 15.82 MB + 2 = 17opening another port on Proxmox.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" '''English:''' "Device Manager" -> "System Devices" -> "PCI standard RAM Controller" 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/virtiolg**YOUR-win/directWINDOWS-downloads/upstream-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 its 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 by downloading owned. You will need to create a hook script to set the correct version permissions for your release from https:/them (/looking-glass.ioetc/downloads. You can either choose between '''Official Releases''' which is is stable or '''Release Candidates''' that tries to be stable but has new featurestmpfile. 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.
Next<syntaxhighlight lang=bash># 3rd party script, extract created by the zip archive. Thencommunity, run the "lookingnot part of Looking Glass project!# Assuming you have set up a storage named `local-glass-host-setup.exe" installer btrfs` and click through it. By default, the installer will install a service that automatically starts the host application is mounted at boot`/var/lib/pve/local-btrfs`wget https://github. The installer can also be installed in silent mode with the "com/S" switch. Other command line options for the installer are documented by running it with the "MakiseKurisu/h" switch. There is also an unofficial Chocolatey package available, install with "choco install lookingsingle-glassnode-host homelab/raw/c6daee9c242571977a0af9088c4d7360dd309685/ansible/proxmox-init/pve-pre" The windows host application captures the windows desktop and stuffs the frames into the shared memory via the shared memory virtual device, without this 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. '''Note:''' As of 2020helper -10O /var/lib/pve/local-23, Microsoft Defender is known to mark the Lookingbtrfs/snippets/pve-Glass host executable as a virus and in some cases will automatically delete the file.helper '''Note:''' As of 2020chmod +x /var/lib/pve/local-08-12 (commit dc4d1d49fac2361e60c9bb440bc88ce05f6c1cbd), the below instructions are deprecated. The host application now has an installer that installs a systembtrfs/snippets/pve-wide service to run the Looking Glass host application. When upgrading please be sure to remove the scheduled task if you have already created one.helper<div class="toccolours mwqm set $VMID -collapsible mw-collapsed">Instructions for versions prior to 2020hookscript=local-08btrfs:snippets/pve-12.helper<div class=echo "mw#lg-collapsible-contentchown user">To get the Windows-Host-Application running after restart you need to run it as a privileged task we do that by starting '''cmd.exe''' as '''administrator''' and running a command in it which creates a windows task. '''Note:''' 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. <syntaxhighlight lang=batch>SCHTASKS /Create /TN "Looking Glass" /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.
</div></div>
== 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, and '-F' to automatically enter full screen.
→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 >
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>
=== Installing Additional Dependencies for Kernel Module Build ===
<syntaxhighlight lang=bash>
dnf install dkms kernel-devel kernel-headers
</syntaxhighlight >
== 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>
</syntaxhighlight >
===== OpenSuSE Leap 15.0+ ==Tumbleweed === For Tumbleweed this should do the trick:
<syntaxhighlight lang=bash>
zypper install waylandin binutils-devel clang cmake dejavu-sans-mono-fonts fontconfig-devel gcc gcc-c++ glibc-all-langpacks libdecor-protocolsdevel libglvnd-devel libXsslibnettle-devel libpulse-devel make cmake binutilslibsamplerate-devel libSDL2-devel libSDL2_ttf-devel libnettlelibvulkan1 libwayland-egl-devel libxkbcommon-devel libXpresent-devel libXrandr-devel libXScrnSaver-devel libXss-devel nettle spicemake Mesa-protocollibGLESv3-devel fontconfignettle-devel libX11pipewire-devel libconfigpkgconf-pkg-config pkgconfig spice-protocol-devel libwaylandvulkan-eglloader wayland-devel libXizlib-devel-static
</syntaxhighlight >
=== 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 cmake gcc cmake gnu-free-fonts sdl2 sdl2_ttf libgl libegl fontconfig spice-protocol fontconfig libx11 make nettle pkgconf binutils \ libxi libxinerama libxss libxcursor libxpresent libxkbcommon wayland-protocols \ make pkgconf gluttf-dejavu 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 make gcc pkg-config 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>
</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>
Then boot the Linux VM, and download the latest Looking-glass source from https://looking-glass.io/downloads (Tested with version B5.0.1)
==== AppArmor =Using vGPU merged driver to run Looking Glass on Proxmox Host ===For libvirt versions before '''5.10.0''', if you are using AppArmor, you need to add permissions for QEMU to access the shared memory file. This can be done by adding the following to ''/etc/apparmor.d/abstractions/libvirt-qemu''. /dev/shm/looking-glass rw,
<syntaxhighlight lang=bash>
</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>
</syntaxhighlight>
