Difference between revisions of "Installation on other distributions"

From Looking Glass
Jump to navigation Jump to search
(→‎Arch Linux / Manjaro: Re-order to match Debian, and segregate platform-specific deps)
 
(60 intermediate revisions by 28 users not shown)
Line 1: Line 1:
−
== Looking Glass Client ==
 
  
−
This guide will step you through building the looking glass client from source, before you attempt to do this you should have a basic understanding of how to use the shell.
+
The [https://looking-glass.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, which do not work using the Debian instructions.
  
−
=== Building the Application ===
+
<!-- Debian example for reference. Do not include --!
−
----
 
−
==== Installing Build Dependencies ====
 
  
−
* binutils-dev
+
apt-get install binutils-dev cmake fonts-freefont-ttf libfontconfig1-dev libegl-dev libspice-protocol-dev nettle-dev libx11-dev libxi-dev libxinerama-dev libxss-dev libwayland-dev wayland-protocols
−
* cmake
+
-->
−
* fonts-freefont-ttf
 
−
* libsdl2-dev
 
−
* libsdl2-ttf-dev
 
−
* libspice-protocol-dev
 
−
* libfontconfig1-dev
 
−
* libx11-dev
 
−
* nettle-dev
 
  
−
===== 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 lang=bash>
−
apt-get install binutils-dev cmake fonts-freefont-ttf libsdl2-dev libsdl2-ttf-dev libspice-protocol-dev libfontconfig1-dev libx11-dev nettle-dev
+
dnf install cmake gcc gcc-c++ libglvnd-devel fontconfig-devel spice-protocol make nettle-devel \
 +
            pkgconf-pkg-config binutils-devel libXi-devel libXinerama-devel libXcursor-devel \
 +
            libXpresent-devel libxkbcommon-x11-devel wayland-devel wayland-protocols-devel \
 +
            libXScrnSaver-devel libXrandr-devel dejavu-sans-mono-fonts
 
</syntaxhighlight >
 
</syntaxhighlight >
  
−
===== Fedora 29+ =====
+
For wayland support you will also need the following packages
  
 
<syntaxhighlight lang=bash>
 
<syntaxhighlight lang=bash>
−
dnf install binutils-devel gcc cmake texlive-gnu-freefont SDL2-devel SDL2_ttf-devel spice-protocol fontconfig-devel libX11-devel nettle-devel \
+
dnf install libdecor-devel
−
            mesa-libGLU-devel libXfixes-devel libXi-devel wayland-devel
+
</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>
 +
 
 +
=== 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>
 +
zypper install binutils-devel make cmake fontconfig-devel libSDL2-devel libSDL2_ttf-devel spice-protocol-devel libX11-devel libnettle-devel wayland-protocols-devel \
 +
              libconfig-devel libXi-devel libXss-devel libwayland-egl-devel nettle
 
</syntaxhighlight >
 
</syntaxhighlight >
  
−
===== OpenSuSE Leap 15.0+ =====
+
=== Tumbleweed ===
 +
 
 +
For Tumbleweed this should do the trick:
  
 
<syntaxhighlight lang=bash>
 
<syntaxhighlight lang=bash>
−
zypper install wayland-protocols-devel libXss-devel make cmake binutils-devel libSDL2-devel libSDL2_ttf-devel libnettle-devel nettle spice-protocol-devel fontconfig-devel libX11-devel libconfig-devel libwayland-egl-devel libXi-devel
+
sudo zypper in binutils-devel clang cmake dejavu-fonts fontconfig-devel gcc gcc-c++ glibc-locale 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 pipewire-devel pkgconf-pkg-config pkgconfig spice-protocol-devel vulkan wayland-devel zlib-devel-static
 
</syntaxhighlight >
 
</syntaxhighlight >
  
−
===== Arch Linux / Manjaro =====
+
== 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>
 
<syntaxhighlight lang=bash>
−
pacman -Syu binutils gcc cmake gnu-free-fonts sdl2 sdl2_ttf spice-protocol fontconfig libx11 nettle \
+
pacman -Syu cmake gcc libgl libegl fontconfig spice-protocol make nettle pkgconf binutils \
−
             make pkgconf glu
+
            libxi libxinerama libxss libxcursor libxpresent libxkbcommon wayland-protocols \
 +
             ttf-dejavu libsamplerate
 
</syntaxhighlight>
 
</syntaxhighlight>
  
−
===== Void Linux =====
+
=== Installing Additional Dependencies for Kernel Module Build ===
  
 
<syntaxhighlight lang=bash>
 
<syntaxhighlight lang=bash>
−
xbps-install -Syu make gcc pkg-config binutils-devel cmake freefont-ttf SDL2-devel SDL2_ttf-devel spice-protocol fontconfig-devel libX11-devel nettle-devel
+
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 libX11-devel libXpresent-devel libXinerama-devel nettle-devel \
 +
                  gcc make pkg-config
 
</syntaxhighlight>
 
</syntaxhighlight>
  
−
===== Gentoo =====
+
== Gentoo ==
 +
 
 +
=== Installing Dependencies ===
 
First set up the necessary USE flags if needed:
 
First set up the necessary USE flags if needed:
 
<syntaxhighlight lang=bash>
 
<syntaxhighlight lang=bash>
Line 56: Line 94:
 
</syntaxhighlight>
 
</syntaxhighlight>
 
Then fetch the packages:
 
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>
 
<syntaxhighlight lang=bash>
−
emerge sys-devel/binutils media-libs/libsdl2 media-libs/sdl2-ttf dev-libs/nettle media-libs/fontconfig dev-util/cmake app-emulation/spice-protocol media-fonts/freefonts media-libs/glu
+
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>
 
</syntaxhighlight>
 
This list can also be placed into a setfile in /etc/portage/sets/ so that they can be updated with  
 
This list can also be placed into a setfile in /etc/portage/sets/ so that they can be updated with  
Line 64: Line 105:
 
</syntaxhighlight>
 
</syntaxhighlight>
  
−
==== Downloading ====
+
== Proxmox ==
  
−
Either visit the site at [https://looking-glass.hostfission.com/downloads Looking Glass Download Page]
+
=== Prerequisites ===
  
−
Or pull the lastest '''bleeding-edge version''' using the '''git''' command.
+
* A working Proxmox install on a computer with 2 GPU's (Tested with 7.1-6)
 +
* A Windows VM with GPU pass-through working (Tested with Win 10)
 +
* A Linux VM with GPU pass-through working (Tested With Ubuntu 21.10)
 +
* Proxmox Host Installed and running on the Windows VM
  
−
'''Note: If you are using the latest bleeding-edge from the master branch you MUST download/use the corresponding host application'''
+
During Proxmox 7 lifecycle they shipped a newer OVMF firmware than tested, and breaks '''kvmfr''' module. Currently the workaround is to use an older version of it:
  
−
<syntaxhighlight lang=bash>
+
apt install pve-edk2-firmware=3.20220526-1
−
git clone --recursive https://github.com/gnif/LookingGlass.git
+
apt-mark hold pve-edk2-firmware
−
</syntaxhighlight >
 
  
−
==== 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>
+
apt full-upgrade
−
mkdir client/build
 
−
cd client/build
 
−
cmake ../
 
−
make
 
−
</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.
+
=== Windows VM setup ===
  
−
Should this all go well you should be left with 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.
+
Using the Proxmox GUI, Set the Windows VM Display to "none"
  
−
You can call the client from the build directory; or, you can make it callable generally by adding the directory to your path or issuing
+
Then in a shell to the Proxmox host edit the Windows VM Config:
 
<syntaxhighlight lang=bash>
 
<syntaxhighlight lang=bash>
−
ln -s $(pwd)/looking-glass-client /usr/local/bin/
+
nano /etc/pve/qemu-server/**YOUR-WINDOWS-VM-ID**.conf
 
</syntaxhighlight>
 
</syntaxhighlight>
−
from the build directory.
+
And add the 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=[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.
  
−
=== libvirt Configuration ===
+
[spice port] should be replaced by a tcp port not in use.
−
----
 
−
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 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 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.
+
In a shell to the Proxmox host edit the Linux VM Config:
−
<syntaxhighlight lang=xml>
+
<syntaxhighlight lang=bash>
−
<shmem name='looking-glass'>
+
nano /etc/pve/qemu-server/**YOUR-LINUX-VM-ID**.conf
−
  <model type='ivshmem-plain'/>
+
</syntaxhighlight>
−
  <size unit='M'>32</size>
+
And add the arguments to the args: line. If the args: line doesn't exist, create it at the top of the config.  
−
</shmem>
+
<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>
 
</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)
  
−
The memory size (show as 32 in the example above) may need to be adjusted as per [[Installation#Determining_Memory|Determining Memory]] section.
+
Follow the Official Looking-glass documentation on how to Build Looking-Glass Client - https://looking-glass.io/docs/B5.0.1/build/#building
  
−
==== Spice Server ====
+
Follow the Official Looking-glass documentation on how to install the kernel module - https://looking-glass.io/docs/B5.0.1/module/
−
If you would like to use Spice to give you keyboard and mouse input along with clipboard sync support, make sure you have a <code><graphics type='spice'></code> device, then:
 
  
−
* Find your <code><video></code> device, and set <code><model type='none'></code>
+
=== Running Looking-Glass ===
−
** 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 type='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 to enable clipboard synchronization via SPICE]]
+
# 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=bash>
 +
./looking-glass-client -f /dev/kvmfr0 -c **Your_Proxmox_Host_IP** -p **spice port specified**
 +
</syntaxhighlight>
  
−
==== 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,
 
  
−
=== Qemu Commands ===
+
This currently only work for Windows guest, as Looking Glass Linux Host is immature at the moment.
−
----
 
−
'''If you are using virt manager/libvirt then this does not apply to you.'''
 
  
−
Add the following to the commands to your QEMU command line, adjusting the bus to suit your particular configuration:  
+
You can simplify the guest set up by replacing the IVSHMEM settings in <code>args</code> with the following line:
 
<syntaxhighlight lang=bash>
 
<syntaxhighlight lang=bash>
−
-device ivshmem-plain,memdev=ivshmem,bus=pcie.0 \
+
ivshmem: size=32
−
-object memory-backend-file,id=ivshmem,share=on,mem-path=/dev/shm/looking-glass,size=32M
 
 
</syntaxhighlight>
 
</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.
  
−
The memory size (show as 32 in the example above) may need to be adjusted as per [[Installation#Determining_Memory|Determining Memory]] section.
+
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=32,name=**WINDOWS-VMID**
 +
</syntaxhighlight>
 +
This will override Proxmox to open <code>/dev/shm/pve-shm-**name**</code> instead, and since the default for **name** is **VMID**, set that to your Windows's VMID does the trick.
  
−
=== Determining Memory ===
+
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't need access Looking Glass from another VM.
−
----
+
<syntaxhighlight lang=bash>
−
You will need to adjust the memory size to a value that is suitable for your desired maximum resolution using the following formula:
+
-spice unix=on,addr=/run/lg**YOUR-WINDOWS-VM-ID**.socket,disable-ticketing=on
−
 
 
−
<code>
 
−
width x height x 4 x 2 = total bytes
 
−
total bytes / 1024 / 1024 = total megabytes + 2
 
−
</code>
 
−
 
 
−
For example, for a resolution of 1920x1080 (1080p)
 
−
 
 
−
<code>
 
−
1920 x 1080 x 4 x 2 = 16,588,800 bytes
 
−
16,588,800 / 1024 / 1024 = 15.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 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):
 
−
 
 
−
<code>
 
−
touch /dev/shm/looking-glass && chown user:kvm /dev/shm/looking-glass && chmod 660 /dev/shm/looking-glass
 
−
</code>
 
−
 
 
−
== Looking Glass Service (Windows) ==
 
−
 
 
−
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.
 
−
 
 
−
=== Installing the IVSHMEM Driver ===
 
−
----
 
−
Windows will not prompt for a driver for the IVSHMEM device, 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://fedorapeople.org/groups/virt/virtio-win/direct-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-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:
 
−
 
 
−
<syntaxhighlight lang=INI>
 
−
[os]
 
−
shmDevice=1
 
 
</syntaxhighlight>
 
</syntaxhighlight>
  
−
=== Using the Windows Host Application ===
+
However, those 2 files will be created as root-owned. You will need to create a hook script to set the correct permissions for them (/etc/tmpfile.d was having reliability issue on my machine for IVSHMEM file, and it cannot override socket file's ownership at all):
−
----
 
−
Start by downloading the correct version for your release from https://looking-glass.io/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.
 
  
−
Next, extract the zip archive. Then, run the "looking-glass-host-setup.exe" installer and click through it. By default, the installer will install a service that automatically starts the host application at boot. The installer can also be installed in silent mode with the "/S" switch. Other command line options for the installer are documented by running it with the "/h" switch. There is also an unofficial Chocolatey package available, install with "choco install looking-glass-host --pre"
+
<syntaxhighlight lang=bash>
−
 
+
# 3rd party script, created by the community, not part of Looking Glass project!
−
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.
+
# Assuming you have set up a storage named `local-btrfs` and is mounted at `/var/lib/pve/local-btrfs`
−
 
+
wget https://github.com/MakiseKurisu/single-node-homelab/raw/c6daee9c242571977a0af9088c4d7360dd309685/ansible/proxmox-init/pve-helper -O /var/lib/pve/local-btrfs/snippets/pve-helper
−
 
+
chmod +x /var/lib/pve/local-btrfs/snippets/pve-helper
−
'''Note:''' As of 2020-10-23, Microsoft Defender is known to mark the Looking-Glass host executable as a virus and in some cases will automatically delete the file.
+
qm set $VMID --hookscript=local-btrfs:snippets/pve-helper
−
 
+
echo "#lg-chown user" >> /etc/pve/qemu-server/$VMID.conf
−
'''Note:''' As of 2020-08-12 (commit dc4d1d49fac2361e60c9bb440bc88ce05f6c1cbd), the below instructions are deprecated. The host application now has an installer that installs a system-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.
 
−
 
 
−
<div class="toccolours mw-collapsible mw-collapsed">
 
−
Instructions for versions prior to 2020-08-12.
 
−
<div class="mw-collapsible-content">
 
−
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 /RL HIGHEST /TR C:\Users\<YourUserName>\<YourPath>\looking-glass-host.exe
 
 
</syntaxhighlight>
 
</syntaxhighlight>
−
 
−
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.
 

Latest revision as of 05:36, 26 August 2024

The Official Documentation contains installation instructions for Debian-based distributions and should work fine on derivatives. The following are supplemental guides for other distributions, which do not work using the Debian instructions.


Fedora 35+[edit]

Installing Dependencies for Client Build[edit]

dnf install cmake gcc gcc-c++ libglvnd-devel fontconfig-devel spice-protocol make nettle-devel \
            pkgconf-pkg-config binutils-devel libXi-devel libXinerama-devel libXcursor-devel \
            libXpresent-devel libxkbcommon-x11-devel wayland-devel wayland-protocols-devel \
            libXScrnSaver-devel libXrandr-devel dejavu-sans-mono-fonts

For wayland support you will also need the following packages 

dnf install libdecor-devel

For audio support in Bleeding Edge, the following packages should also be installed:

PipeWire users: 

dnf install pipewire-devel libsamplerate-devel

PulseAudio users: 

dnf install pulseaudio-libs-devel libsamplerate-devel

Installing Additional Dependencies for Kernel Module Build[edit]

dnf install dkms kernel-devel kernel-headers

OpenSuSE Leap 15.0+[edit]

Installing Dependencies[edit]

zypper install binutils-devel make cmake fontconfig-devel libSDL2-devel libSDL2_ttf-devel spice-protocol-devel libX11-devel libnettle-devel wayland-protocols-devel \
               libconfig-devel libXi-devel libXss-devel libwayland-egl-devel nettle

Tumbleweed[edit]

For Tumbleweed this should do the trick: 

sudo zypper in binutils-devel clang cmake dejavu-fonts fontconfig-devel gcc gcc-c++ glibc-locale 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 pipewire-devel pkgconf-pkg-config pkgconfig spice-protocol-devel vulkan wayland-devel zlib-devel-static

Arch Linux / Manjaro[edit]

Installing Dependencies for Client Build[edit]

pacman -Syu cmake gcc libgl libegl fontconfig spice-protocol make nettle pkgconf binutils \
            libxi libxinerama libxss libxcursor libxpresent libxkbcommon wayland-protocols \
            ttf-dejavu libsamplerate

Installing Additional Dependencies for Kernel Module Build[edit]

pacman -Syu dkms linux-headers

Void Linux[edit]

Installing Dependencies[edit]

xbps-install -Syu binutils-devel cmake freefont-ttf fontconfig-devel SDL2-devel SDL2_ttf-devel spice-protocol libX11-devel libXpresent-devel libXinerama-devel nettle-devel \
                  gcc make pkg-config

Gentoo[edit]

Installing Dependencies[edit]

First set up the necessary USE flags if needed: 

echo "media-libs/libsdl2 gles2" >> /etc/portage/package.use/libsdl2
echo "media-libs/nettle gmp" >> /etc/portage/package.use/nettle

Then fetch the packages: 

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

This list can also be placed into a setfile in /etc/portage/sets/ so that they can be updated with 

emerge @setfile

Proxmox[edit]

Prerequisites[edit]

  • A working Proxmox install on a computer with 2 GPU's (Tested with 7.1-6)
  • A Windows VM with GPU pass-through working (Tested with Win 10)
  • A Linux VM with GPU pass-through working (Tested With Ubuntu 21.10)
  • Proxmox Host Installed and running on the Windows VM

During Proxmox 7 lifecycle they shipped a newer OVMF firmware than tested, and breaks kvmfr module. Currently the workaround is to use an older version of it: 

apt install pve-edk2-firmware=3.20220526-1
apt-mark hold pve-edk2-firmware

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: 

apt-mark unhold pve-edk2-firmware
apt full-upgrade

Windows VM setup[edit]

Using the Proxmox GUI, Set the Windows VM Display to "none"

Then in a shell to the Proxmox host edit the Windows VM Config: 

nano /etc/pve/qemu-server/**YOUR-WINDOWS-VM-ID**.conf

And add the following arguments to the args: line. If the args: line doesn't exist, create it at the top of the config. 

-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

The -device virtio-mouse-pci -device virtio-keyboard-pci are not strictly necessary but should reduce input latency.

[spice port] should be replaced by a tcp port not in use.

Boot the Windows VM

Linux VM setup[edit]

In a shell to the Proxmox host edit the Linux VM Config: 

nano /etc/pve/qemu-server/**YOUR-LINUX-VM-ID**.conf

And add the arguments to the args: line. If the args: line doesn't exist, create it at the top of the config. 

-device ivshmem-plain,memdev=ivshmem,bus=pcie.0 -object memory-backend-file,id=ivshmem,share=on,mem-path=/dev/shm/looking-glass,size=32M

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.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/

Running Looking-Glass[edit]

  1. Make sure both VMs are running.
  2. On the Linux VM, open a terminal and cd to the looking glass client build folder
  3. Run Looking-Glass with:
 ./looking-glass-client -f /dev/kvmfr0 -c **Your_Proxmox_Host_IP** -p **spice port specified**

Using vGPU merged driver to run Looking Glass on Proxmox Host[edit]

This currently only work for Windows guest, as Looking Glass Linux Host is immature at the moment.

You can simplify the guest set up by replacing the IVSHMEM settings in args with the following line: 

ivshmem: size=32

This will create a 32M IVSHMEM file under /dev/shm/pve-shm-**VMID**. You will need to point app:shmFile to this file when launching LG client.

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: 

ivshmem: size=32,name=**WINDOWS-VMID**

This will override Proxmox to open /dev/shm/pve-shm-**name** instead, and since the default for **name** is **VMID**, set that to your Windows's VMID does the trick.

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't need access Looking Glass from another VM. 

-spice unix=on,addr=/run/lg**YOUR-WINDOWS-VM-ID**.socket,disable-ticketing=on

However, those 2 files will be created as root-owned. You will need to create a hook script to set the correct permissions for them (/etc/tmpfile.d was having reliability issue on my machine for IVSHMEM file, and it cannot override socket file's ownership at all): 

# 3rd party script, created by the community, not part of Looking Glass project!
# Assuming you have set up a storage named `local-btrfs` and is mounted at `/var/lib/pve/local-btrfs`
wget https://github.com/MakiseKurisu/single-node-homelab/raw/c6daee9c242571977a0af9088c4d7360dd309685/ansible/proxmox-init/pve-helper -O /var/lib/pve/local-btrfs/snippets/pve-helper
chmod +x /var/lib/pve/local-btrfs/snippets/pve-helper
qm set $VMID --hookscript=local-btrfs:snippets/pve-helper
echo "#lg-chown user" >> /etc/pve/qemu-server/$VMID.conf
Retrieved from "https://looking-glass.io/mw/index.php?title=Installation_on_other_distributions&oldid=753"