Mirrored_Repos/LookingGlass
1
0
Fork 0
mirror of https://github.com/gnif/LookingGlass.git synced 2026-11-06 11:57:20 +00:00
Code Issues Actions 3 Packages Projects Releases Wiki Activity

[doc] install_idd: Cleanup

Browse Source
This commit is contained in:
Jonathan Rubenstein
2026-11-05 11:14:15 +02:00
committed by Geoffrey McRae
parent 8c17f32598
commit 3a7eb6f096
1 changed files with 32 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files

52
doc/install_idd.rst
View File

@@ -3,28 +3,29 @@
Looking Glass IDD
#################
.. _install_idd:
The Looking Glass IDD is the recommended Looking Glass server implementation for
Windows guests. Download the ``looking-glass-idd-setup.exe`` installer that
matches the client release, run it as an administrator inside the Windows guest
matches the client release, run it as an administrator inside the Windows guest,
and follow the installer.
The installer includes the display driver, direct input driver and IDD helper.
It can also install the IVSHMEM driver. If the legacy Host service is present,
allow the installer to disable it so that only one Looking Glass server is
active.
It can also install the IVSHMEM driver. If the legacy host service is already
installed, allow the installer to disable it so that only one Looking Glass
server is active.
The display may briefly disappear while Windows installs or reloads the
driver. Restart Windows if the installer requests it.
.. _install_idd:
Install
-------
1. Download the IDD installer from the same release as the client source.
2. Run ``looking-glass-idd-setup.exe`` as an administrator in Windows.
1. `Download the IDD installer <https://looking-glass.io/downloads>`__ from the
same release as the client.
2. Run ``looking-glass-idd-setup.exe`` as an administrator in the guest.
3. Select **IVSHMEM Driver** if a suitable IVSHMEM driver is not already
installed in the guest.
installed.
4. Leave **Indirect Display Driver (IDD)** selected.
5. If offered, leave **Disable old host app** selected. Running two servers
against the same shared-memory device is not supported.
@@ -34,39 +35,48 @@ After installation, Windows should show a display named Looking Glass and the
IDD helper should appear in the notification area. The helper icon reports
whether the IDD is using GPU acceleration or software processing.
The IDD installer also installs its direct input driver. There is no separate
The IDD installer also installs its direct input driver, there is no separate
input package to install.
.. _upgrade_idd:
Upgrade
-------
Download the correct version of the IDD installer and run it over the existing
installation. Close all active clients and OBS sources, then upgrade the Linux
client and OBS plugin to the same version as the installed IDD before launching
them again.
1. Download the desired version of the IDD installer and run it over the
existing installation.
2. Close all active clients and OBS sources.
3. Upgrade the Looking Glass client and OBS plugin to the same version as the
IDD.
Windows may briefly remove and recreate the virtual display. Restart Windows
when the installer reports that a restart is required.
.. _uninstall_idd:
Uninstall
---------
Remove **Looking Glass (IDD)** from Windows **Installed apps** or **Programs
and Features**. This removes both the display and input drivers and deletes
- Remove **Looking Glass (IDD)** from Windows' **Installed apps** or **Programs
and Features**.
This removes both the display and input drivers and deletes
custom IDD modes and preferences. The optional IVSHMEM files are removed from
the Looking Glass installation directory, but an IVSHMEM driver package that
was already installed in Windows is not uninstalled.
If you are returning to the legacy Host Application, re-enable or reinstall
its service only after the IDD has been removed.
If you are installing the legacy host application, re-enable or reinstall the
host service only after the IDD has been removed.
.. _silent_install_idd:
Silent installation
-------------------
The installer accepts these options for managed installations:
The installer accepts these (case-sensitive) options for managed installations:
``/S``
Install silently. The uppercase spelling is required.
Install silently.
``/ivshmem``
Install the bundled IVSHMEM driver when it is present in the installer.
@@ -75,6 +85,8 @@ The installer accepts these options for managed installations:
Change the installation directory. This must be the final option and must
not be quoted.
.. _configure_idd:
Configuration and diagnostics
-----------------------------