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 wayland support you will also need the following packages
yum dnf install make cmake binutils-devel SDL2-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-libEGLlibdecor-devel</syntaxhighlight >
===== OpenSuSE Leap 15.0+ ===== <syntaxhighlight lang=bash>zypper install make cmake binutils-devel libSDL2-devel libSDL2_ttf-devel libnettle-devel nettle spice-protocol-devel fontconfig-devel libX11-devel libconfig-devel libwayland-egl-devel libX11fixes-devel</syntaxhighlight >For audio support in Bleeding Edge, the following packages should also be installed:
===== Arch / Manjaro =====PipeWire users:
pacman dnf install pipewire-Syu binutilsdevel libsamplerate-dev cmake fonts-freefont-ttf libsdl2-dev libsdl2-ttf-dev libspice-protocol-dev bfontconfig1-dev libx11-dev nettle-devdevel
===== Void Linux =====PulseAudio users:
xbps-dnf install pulseaudio-Syu binutils-devel cmake freefont-ttf SDL2-devel SDL2_ttf-devel spice-protocol fontconfig-devel libX11libs-devel nettlelibsamplerate-devel
Either visit the site at [https://looking-glass.hostfission.com/downloads Looking Glass Download Page]
Or pull the lastest using the '''git''' command.
git clone https://github.com/gnif/LookingGlass.gitdnf install dkms kernel-devel kernel-headers
If you downloaded the file via the web link then you should have a 'zip=== Installing Dependencies === <!-- 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/buildcd client/buildzypper install binutils-devel make cmake ../fontconfig-devel libSDL2-devel libSDL2_ttf-devel spice-protocol-devel libX11-devel libnettle-devel wayland-protocols-devel \make libconfig-devel libXi-devel libXss-devel libwayland-egl-devel nettle</syntaxhighlight>
;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.== 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 set up the Windows side service.trick:
'''If you are using QEMU directly, this does not apply to you.'''== Arch Linux / Manjaro ==
Add the following to the libvirt machine configuration inside the === Installing Dependencies for Client Build === <!-- Dependencies must match Debian'devices' section by running "virsh edit VM" where VM is the name of your virtual machine.s order, and extra dependencies must be on another line, with a consistent order --><syntaxhighlight lang=xmlbash><shmem name='lookingpacman -Syu cmake gcc libgl libegl fontconfig spice-glass'>protocol make nettle pkgconf binutils \ <model type='ivshmem libxi libxinerama libxss libxcursor libxpresent libxkbcommon wayland-plain'/>protocols \ <size unit='M'>32</size></shmem> ttf-dejavu libsamplerate
The memory size (show as 32 in the example above may need to be adjusted as per [[Installation#Determining_Memory|Determining Memory]] section.=== Installing Additional Dependencies for Kernel Module Build === <syntaxhighlight lang=bash>pacman -Syu dkms linux-headers</syntaxhighlight >
Add the following to the commands to your QEMU command === Installing Dependencies === <!-- 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 -->
The memory size (show as 32 in the example above may need to be adjusted as per [[Installation#Determining_Memory|Determining Memory]] section.== Gentoo ==
<code>width x height x 4 x 2 = total bytestotal bytes / 1024 / 1024 = total megabytes + 2</code>Proxmox ==
For example, for a resolution of 1920x1080 (1080p)=== Prerequisites ===
<code>* A working Proxmox install on a computer with 2 GPU's (Tested with 7.1-6)1920 x 1080 x 4 x 2 = 16,588,800 bytes* A Windows VM with GPU pass-through working (Tested with Win 10)16,588,800 / 1024 / 1024 = 15.82 MB + 2 = 17* A Linux VM with GPU pass-through working (Tested With Ubuntu 21.8210)</code>* Proxmox Host Installed and running on the Windows VM
You must round this value up During Proxmox 7 lifecycle they shipped a newer OVMF firmware than tested, and breaks '''kvmfr''' module. Currently the workaround is to the nearest power use an older version of two, which with the above example would be 32MBit:
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 install pve-edk2-firmware=3.20220526-1 apt-mark hold pve-edk2-firmware
<code>touch /dev/shm/lookingFor Proxmox 8, the current pve-glass && chown user:kvm /dev/shm/lookingedk2-glass && chmod 660 /dev/shm/lookingfirmware version 3.20230228-glass</code>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:
== Looking Glass Service (Windows) == apt-mark unhold pve-edk2-firmware apt full-upgrade
You must first run the === Windows VM with the changes noted above in either the [[Installation#libvirt_Configuration|libvirt]] or [[Installation#Qemu_Commands|Qemu]] sections.setup ===
=== Installing Using the IVSHMEM Driver ===----Windows will not prompt for a driver for the IVSHMEM device, insteadProxmox GUI, it will use a default null (do nothing) driver for Set the device. To install the IVSHMEM driver you will need Windows VM Display to go into the device manager and update the driver for the device "PCI standard RAM Controller" under the "System Devicesnone" node.
A signed Then in a shell to the Proxmox host edit the Windows 10 driver can be obtained from Red Hat for this device from 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 below addressargs: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.
https://fedorapeople[spice port] should be replaced by a tcp port not in use.org/groups/virt/virtio-win/direct-downloads/upstream-virtio/
Please note that you must obtain version 0.1.161 or laterBoot the Windows VM
<syntaxhighlight lang=INI>[os]shmDevice=Follow the Official Looking-glass documentation on how to Build Looking-Glass Client - https://looking-glass.io/docs/B5.0.1</syntaxhighlight>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>
add wayland build dependencies for fedora
===== 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>
<syntaxhighlight lang=bash>
</syntaxhighlight>
<syntaxhighlight lang=bash>
</syntaxhighlight>
==== Downloading =Installing Additional Dependencies for Kernel Module Build ===
<syntaxhighlight lang=bash>
</syntaxhighlight >
==== Building ==OpenSuSE Leap 15.0+ ==
<syntaxhighlight lang=bash>
<syntaxhighlight lang=== libvirt Configuration ===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-staticThis 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.</syntaxhighlight >
</syntaxhighlight>
==Void Linux = Qemu Commands ===----'''If you are using virt manager then this does not apply to you.'''
<syntaxhighlight lang=bash>
xbps-device ivshmeminstall -plain,memdev=ivshmem,bus=pcie.0 \Syu binutils-devel cmake freefont-ttf fontconfig-devel SDL2-devel SDL2_ttf-devel spice-protocol libX11-object memorydevel libXpresent-backenddevel libXinerama-file,id=ivshmem,share=on,memdevel nettle-path=/dev/shm/lookingdevel \ gcc make pkg-glass,size=32Mconfig
</syntaxhighlight>
=== Determining Memory 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-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>You will need to adjust the memory size to 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 value setfile in /etc/portage/sets/ so that is suitable for your desired maximum resolution using the following formula:they can be updated with <syntaxhighlight lang=bash>emerge @setfile</syntaxhighlight>
==== A note about IVSHMEM and Scream Audio =Linux VM setup ===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.
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 you insist on using IVSHMEM for Scream despite the args: line doesn't exist, create it's inferiority to at the default network implementation top of the Windows Host Application can be told what config. <syntaxhighlight lang=bash>-device to useivshmem-plain,memdev=ivshmem,bus=pcie. Create a 0 -object memory-backend-file,id=ivshmem,share=on,mem-path=/dev/shm/looking-glass-host.ini file in ,size=32M</syntaxhighlight>Then boot the same directory as Linux VM, and download the latest Looking-glass source from https://looking-glass-host.exe fileio/downloads (Tested with version B5.0. In it, you can use the os:shmDevice option like so:1)
</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.
