| Latest revision |
Your text |
| Line 1: |
Line 1: |
| | + | == Looking Glass Client == |
| | | | |
| − | 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.
| + | This guide will step you through building the looking glass client on Debian based systems from source, before you attempt to do this you should have a basic understanding how to use the shell. |
| | | | |
| − | <!-- Debian example for reference. Do not include --!
| + | === Building the Application === |
| | + | ---- |
| | + | ==== Build Dependancies ==== |
| | | | |
| − | 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
| + | * binutils-dev |
| − | -->
| + | * cmake |
| | + | * fonts-freefont-ttf |
| | + | * libsdl2-dev |
| | + | * libsdl2-ttf-dev |
| | + | * libspice-protocol-dev |
| | + | * libfontconfig1-dev |
| | + | * libx11-dev |
| | + | * nettle-dev |
| | | | |
| − | == Fedora 35+ == | + | ===== Debian (and maybe Ubuntu) ===== |
| | | | |
| − | === Installing Dependencies for Client Build ===
| + | <code> |
| − | <!-- Dependencies must match Debian's order, and extra dependencies must be on another line, with a consistent order -->
| + | apt-get install binutils-dev cmake fonts-freefont-ttf libsdl2-dev libsdl2-ttf-dev libspice-protocol-dev libfontconfig1-dev libx11-dev nettle-dev |
| − | <syntaxhighlight lang=bash>
| + | </code> |
| − | 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 > | |
| | | | |
| − | For audio support in Bleeding Edge, the following packages should also be installed:
| + | ===== Fedora 29+ ===== |
| | | | |
| − | PipeWire users:
| + | <code> |
| | + | yum 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-libEGL-devel |
| | + | </code> |
| | | | |
| − | <syntaxhighlight lang=bash>
| + | ===== OpenSuSE Leap 15.0+ ===== |
| − | dnf install pipewire-devel libsamplerate-devel
| |
| − | </syntaxhighlight>
| |
| | | | |
| − | PulseAudio users:
| + | <code> |
| − | <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 |
| − | dnf install pulseaudio-libs-devel libsamplerate-devel
| + | </code> |
| − | </syntaxhighlight> | |
| | | | |
| − | === Installing Additional Dependencies for Kernel Module Build === | + | ==== Downloading ==== |
| | | | |
| − | <syntaxhighlight lang=bash>
| + | Either visit the site at [https://looking-glass.hostfission.com/downloads Looking Glass Download Page] |
| − | dnf install dkms kernel-devel kernel-headers
| |
| − | </syntaxhighlight >
| |
| | | | |
| − | == OpenSuSE Leap 15.0+ ==
| + | Or pull the lastest using the '''git''' command. |
| | + | <code> |
| | + | git clone https://github.com/gnif/LookingGlass.git |
| | + | </code> |
| | | | |
| − | === Installing Dependencies === | + | ==== Building ==== |
| − | <!-- 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 >
| |
| | | | |
| − | === Tumbleweed ===
| + | 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. |
| | | | |
| − | For Tumbleweed this should do the trick:
| + | <code> |
| | + | mkdir build |
| | + | cd build |
| | + | cmake ../ |
| | + | make |
| | + | </code> |
| | | | |
| − | <syntaxhighlight lang=bash>
| + | 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 setup the Windows side service. |
| − | 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 == | + | === Configuring libvirt === |
| | | | |
| − | === Installing Dependencies for Client Build === | + | === Configuring QEMU === |
| − | <!-- Dependencies must match Debian's order, and extra dependencies must be on another line, with a consistent order -->
| |
| − | <syntaxhighlight lang=bash>
| |
| − | pacman -Syu cmake gcc libgl libegl fontconfig spice-protocol make nettle pkgconf binutils \
| |
| − | libxi libxinerama libxss libxcursor libxpresent libxkbcommon wayland-protocols \
| |
| − | ttf-dejavu libsamplerate
| |
| − | </syntaxhighlight>
| |
| | | | |
| − | === Installing Additional Dependencies for Kernel Module Build === | + | == Looking Glass Service (Windows) == |
| | | | |
| − | <syntaxhighlight lang=bash>
| + | == Running the Client == |
| − | 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>
| |
| − | | |
| − | == Gentoo ==
| |
| − | | |
| − | === Installing Dependencies ===
| |
| − | First set up the necessary USE flags if needed:
| |
| − | <syntaxhighlight lang=bash>
| |
| − | echo "media-libs/libsdl2 gles2" >> /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 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 setfile in /etc/portage/sets/ so that they can be updated with
| |
| − | <syntaxhighlight lang=bash>
| |
| − | 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
| |
| − | | |
| − | 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 ===
| |
| − | | |
| − | 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/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
| |
| − | </syntaxhighlight>
| |
