Difference between revisions of "Installation on other distributions"

From Looking Glass
Jump to navigation Jump to search
(Added new build dependencies for Fedora)
 
(16 intermediate revisions by 10 users not shown)
Line 1: Line 1:
  
The [https://looking-glass.io/docs/stable 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.
+
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.
  
 
<!-- Debian example for reference. Do not include --!
 
<!-- Debian example for reference. Do not include --!
  
apt-get install binutils-dev cmake fonts-freefont-ttf libfontconfig1-dev libsdl2-dev libsdl2-ttf-dev libspice-protocol-dev libx11-dev nettle-dev wayland-protocols
+
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
 
 
 
-->
 
-->
  
== Fedora 29+ ==
+
== Fedora 35+ ==
  
=== Installing Dependencies ===
+
=== Installing Dependencies for Client Build ===
 
                               <!-- Dependencies must match Debian's order, and extra dependencies must be on another line, with a consistent order -->
 
                               <!-- Dependencies must match Debian's order, and extra dependencies must be on another line, with a consistent order -->
 
<syntaxhighlight lang=bash>
 
<syntaxhighlight lang=bash>
dnf install binutils-devel cmake texlive-gnu-freefont fontconfig-devel SDL2-devel SDL2_ttf-devel spice-protocol libX11-devel nettle-devel wayland-protocols-devel \
+
dnf install cmake gcc gcc-c++ libglvnd-devel fontconfig-devel spice-protocol make nettle-devel \
             gcc libXScrnSaver-devel libXfixes-devel libXi-devel wayland-devel libXinerama-devel clang glew-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 >
 +
 
 +
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 >
 
</syntaxhighlight >
  
Line 28: Line 48:
 
== Arch Linux / Manjaro ==
 
== Arch Linux / Manjaro ==
  
=== Installing Dependencies ===
+
=== Installing Dependencies for Client Build ===
 
                               <!-- Dependencies must match Debian's order, and extra dependencies must be on another line, with a consistent order -->
 
                               <!-- 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 cmake gnu-free-fonts fontconfig sdl2 sdl2_ttf spice-protocol libx11 nettle \
+
pacman -Syu cmake gcc libgl libegl fontconfig spice-protocol make nettle pkgconf binutils \
             gcc make pkgconf glu
+
             libxi libxinerama libxss libxcursor libxpresent libxkbcommon wayland-protocols \
 +
            ttf-dejavu
 
</syntaxhighlight>
 
</syntaxhighlight>
 +
 +
=== Installing Additional Dependencies for Kernel Module Build ===
 +
 +
<syntaxhighlight lang=bash>
 +
pacman -Syu dkms linux-headers
 +
</syntaxhighlight >
  
 
== Void Linux ==
 
== Void Linux ==
Line 62: Line 89:
 
<syntaxhighlight lang=bash>
 
<syntaxhighlight lang=bash>
 
emerge @setfile
 
emerge @setfile
 +
</syntaxhighlight>
 +
 +
== Proxmox ==
 +
 +
=== Prerequisites ===
 +
 +
* 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
 +
 +
=== Windows VM setup ===
 +
 +
Using the Proxmox GUI, Set the Windows VM Display to "none"
 +
 +
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 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.
 +
 +
[spice port] should be replaced by a tcp port not in use.
 +
 +
Boot the Windows VM
 +
 +
=== Linux VM setup ===
 +
 +
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 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
 +
</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)
 +
 +
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 ===
 +
 +
# 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>
 +
 +
=== Using vGPU merged driver to run Looking Glass on Proxmox Host ===
 +
 +
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 <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 point <code>app:shmFile</code> 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:
 +
<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.
 +
 +
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>
 +
-spice unix=on,addr=/run/lg**YOUR-WINDOWS-VM-ID**.socket,disable-ticketing=on
 +
</syntaxhighlight>
 +
 +
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):
 +
 +
<syntaxhighlight lang=bash>
 +
# 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/435447075c6d36debe55fa11003430194136225e/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
 
</syntaxhighlight>
 
</syntaxhighlight>

Latest revision as of 00:13, 6 August 2022

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

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

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

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/435447075c6d36debe55fa11003430194136225e/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