Editing Installation on other distributions

Jump to navigation Jump to search

Warning: You are not logged in. Your IP address will be publicly visible if you make any edits. If you log in or create an account, your edits will be attributed to your username, along with other benefits.

The edit can be undone. Please check the comparison below to verify that this is what you want to do, and then save the changes below to finish undoing the edit.

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 from source, before you attempt to do this you should have a basic understanding of how to use the shell.
  
<!-- Debian example for reference. Do not include --!
+
=== Building the Application ===
 +
----
 +
==== Installing Build Dependencies ====
  
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 ===
 
                              <!-- 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 cmake gcc gcc-c++ libglvnd-devel fontconfig-devel spice-protocol make nettle-devel \
+
apt-get install binutils-dev cmake fonts-freefont-ttf libsdl2-dev libsdl2-ttf-dev libspice-protocol-dev libfontconfig1-dev libx11-dev nettle-dev
            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 >
  
For audio support in Bleeding Edge, the following packages should also be installed: 
+
===== Fedora 29+ =====
 
+
                              <!-- Dependencies must match Debian's order, and extra dependencies must be on another line, with a consistent order -->
PipeWire users:
 
 
 
 
<syntaxhighlight lang=bash>
 
<syntaxhighlight lang=bash>
dnf install pipewire-devel libsamplerate-devel
+
dnf install binutils-devel cmake texlive-gnu-freefont SDL2-devel SDL2_ttf-devel spice-protocol fontconfig-devel libX11-devel nettle-devel \
</syntaxhighlight>
+
            gcc libXScrnSaver-devel libXfixes-devel libXi-devel wayland-devel wayland-protocols-devel
 
 
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 >
  
== OpenSuSE Leap 15.0+ ==
+
===== OpenSuSE Leap 15.0+ =====
 
 
=== Installing Dependencies ===
 
 
                               <!-- 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>
zypper install binutils-devel make cmake fontconfig-devel libSDL2-devel libSDL2_ttf-devel spice-protocol-devel libX11-devel libnettle-devel wayland-protocols-devel \
+
zypper install binutils-devel make cmake libSDL2-devel libSDL2_ttf-devel spice-protocol-devel fontconfig-devel libX11-devel libnettle-devel \
               libconfig-devel libXi-devel libXss-devel libwayland-egl-devel nettle
+
               libconfig-devel libXi-devel libXss-devel libwayland-egl-devel wayland-protocols-devel nettle
 
</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 -->
 
                               <!-- 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 cmake gcc libgl libegl fontconfig spice-protocol make nettle pkgconf binutils \
+
pacman -Syu binutils cmake gnu-free-fonts sdl2 sdl2_ttf spice-protocol fontconfig libx11 nettle \
             libxi libxinerama libxss libxcursor libxpresent libxkbcommon wayland-protocols \
+
             gcc make pkgconf glu
            ttf-dejavu
 
 
</syntaxhighlight>
 
</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 -->
 
                               <!-- Dependencies must match Debian's order, and extra dependencies must be on another line, with a consistent order -->
 
<syntaxhighlight lang=bash>
 
<syntaxhighlight lang=bash>
xbps-install -Syu binutils-devel cmake freefont-ttf fontconfig-devel SDL2-devel SDL2_ttf-devel spice-protocol libX11-devel nettle-devel \
+
xbps-install -Syu binutils-devel cmake freefont-ttf SDL2-devel SDL2_ttf-devel spice-protocol fontconfig-devel libX11-devel nettle-devel \
 
                   gcc make pkg-config
 
                   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 91: Line 69:
 
</syntaxhighlight>
 
</syntaxhighlight>
  
== Proxmox ==
+
==== Downloading ====
 +
 
 +
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)
+
'''Note: If you are using the latest bleeding-edge from the master branch you MUST download/use the corresponding host application'''
* 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 ===
+
<syntaxhighlight lang=bash>
 +
git clone --recursive https://github.com/gnif/LookingGlass.git
 +
</syntaxhighlight >
  
Using the Proxmox GUI, Set the Windows VM Display to "none"
+
==== Building ====
  
Then in a shell to the Proxmox host edit the Windows VM Config:
+
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.
 
<syntaxhighlight lang=bash>
 
<syntaxhighlight lang=bash>
nano /etc/pve/qemu-server/**YOUR-WINDOWS-VM-ID**.conf
+
mkdir client/build
 +
cd client/build
 +
cmake ../
 +
make
 
</syntaxhighlight>
 
</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.
+
 
 +
;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.
 +
 
 +
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.
 +
 
 +
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
 
<syntaxhighlight lang=bash>
 
<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
+
ln -s $(pwd)/looking-glass-client /usr/local/bin/
 
</syntaxhighlight>
 
</syntaxhighlight>
The -device virtio-mouse-pci -device virtio-keyboard-pci are not strictly necessary but should reduce input latency.
+
from the build directory.
  
[spice port] should be replaced by a tcp port not in use.
+
=== libvirt Configuration ===
 +
----
 +
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.
  
Boot the Windows VM
+
If you use virt-manager, this guide also applies to you, since it uses libvirt.
  
=== Linux VM setup ===
+
'''If you are using QEMU directly, this does not apply to you.'''
  
In a shell to the Proxmox host edit the Linux VM Config:
+
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.
<syntaxhighlight lang=bash>
+
<syntaxhighlight lang=xml>
nano /etc/pve/qemu-server/**YOUR-LINUX-VM-ID**.conf
+
<shmem name='looking-glass'>
 +
  <model type='ivshmem-plain'/>
 +
  <size unit='M'>32</size>
 +
</shmem>
 
</syntaxhighlight>
 
</syntaxhighlight>
And add the arguments to the args: line. If the args: line doesn't exist, create it at the top of the config.
+
 
 +
The memory size (show as 32 in the example above) may need to be adjusted as per [[Installation#Determining_Memory|Determining Memory]] section.
 +
 
 +
==== Spice Server ====
 +
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>
 +
** 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]]
 +
 
 +
==== AppArmor ====
 +
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 ===
 +
----
 +
'''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:
 
<syntaxhighlight lang=bash>
 
<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 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)
 
  
Follow the Official Looking-glass documentation on how to Build Looking-Glass Client - https://looking-glass.io/docs/B5.0.1/build/#building
+
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 install the kernel module - https://looking-glass.io/docs/B5.0.1/module/
+
=== Determining Memory ===
 +
----
 +
You will need to adjust the memory size to a value that is suitable for your desired maximum resolution using the following formula:
  
=== Running Looking-Glass ===
+
<code>
 +
width x height x 4 x 2 = total bytes
 +
total bytes / 1024 / 1024 = total megabytes + 2
 +
</code>
  
# Make sure both VMs are running.
+
For example, for a resolution of 1920x1080 (1080p)
# On the Linux VM, open a terminal and cd to the looking glass client build folder
+
 
# Run Looking-Glass with:
+
<code>
<syntaxhighlight lang=bash>
+
1920 x 1080 x 4 x 2 = 16,588,800 bytes
./looking-glass-client -f /dev/kvmfr0 -c **Your_Proxmox_Host_IP** -p **spice port specified**
+
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 vGPU merged driver to run Looking Glass on Proxmox Host ===
+
=== Using the Windows Host Application ===
 +
----
 +
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"
 +
 
 +
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 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.
 +
 
 +
'''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.
  
This currently only work for Windows guest, as Looking Glass Linux Host is immature at the moment.
+
'''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.
  
You can simplify the guest set up by replacing the IVSHMEM settings in <code>args</code> with the following line:
+
<syntaxhighlight lang=batch>
<syntaxhighlight lang=bash>
+
SCHTASKS /Create /TN "Looking Glass" /SC  ONLOGON /RL HIGHEST /TR C:\Users\<YourUserName>\<YourPath>\looking-glass-host.exe
ivshmem: size=32
 
 
</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.
 
  
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:
+
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")''' .
<syntaxhighlight lang=bash>
+
 
ivshmem: size=32,name=**WINDOWS-VMID**
+
[[File:Screenshot_cmd_windowstask.png|500px]]
</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.
+
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 ==
  
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.
+
The client command is the binary file: '''looking-glass-client'''. This command should run after the Windows Host Application has started.  
<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):
+
For an updated list of arguments visit:
 +
https://github.com/gnif/LookingGlass/blob/master/client/README.md
  
<syntaxhighlight lang=bash>
+
Common options include '-s' for disabling spice, '-S' for disabling the screen saver, and '-F' to automatically enter full screen.
# 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>
 

Please note that all contributions to Looking Glass may be edited, altered, or removed by other contributors. If you do not want your writing to be edited mercilessly, then do not submit it here.
You are also promising us that you wrote this yourself, or copied it from a public domain or similar free resource (see Looking Glass:Copyrights for details). Do not submit copyrighted work without permission!

Cancel Editing help (opens in new window)