mirror of
https://github.com/gnif/LookingGlass.git
synced 2024-11-22 05:27:20 +00:00
[doc] reorder install to before usage and change information re IVSHMEM
This commit is contained in:
Geoffrey McRae
parent
571a5da50f
commit
f489006531
@ -11,8 +11,8 @@ systems for legacy programs that require high-performance graphics.
|
|||||||
:maxdepth: 2
|
:maxdepth: 2
|
||||||
|
|
||||||
requirements
|
requirements
|
||||||
usage
|
|
||||||
install
|
install
|
||||||
|
usage
|
||||||
build
|
build
|
||||||
troubleshooting
|
troubleshooting
|
||||||
obs
|
obs
|
||||||
|
|||||||
141
doc/install.rst
141
doc/install.rst
@ -3,6 +3,71 @@
|
|||||||
Installation
|
Installation
|
||||||
############
|
############
|
||||||
|
|
||||||
|
.. _host_install:
|
||||||
|
|
||||||
|
Host Application
|
||||||
|
----------------
|
||||||
|
|
||||||
|
The Looking Glass Host application captures frames from the guest OS using a
|
||||||
|
capture API, and sends them to the
|
||||||
|
:ref:`Client <client_install>`—be it on the host OS (hypervisor) or another
|
||||||
|
Virtual Machine—through a low-latency transfer protocol over shared memory.
|
||||||
|
|
||||||
|
You can get the host program in two ways:
|
||||||
|
|
||||||
|
- Download a pre-built binary from https://looking-glass.io/downloads
|
||||||
|
(**recommended**)
|
||||||
|
|
||||||
|
- Download the source code as described in :ref:`building`, then
|
||||||
|
:ref:`build the host <host_building>`.
|
||||||
|
|
||||||
|
.. _host_install_windows:
|
||||||
|
|
||||||
|
Windows
|
||||||
|
~~~~~~~
|
||||||
|
|
||||||
|
To begin, you must first run the Windows VM with the changes noted above in
|
||||||
|
either the :ref:`client_libvirt_configuration` or :ref:`client_qemu_commands`
|
||||||
|
sections.
|
||||||
|
|
||||||
|
.. _installing_the_ivshmem_driver:
|
||||||
|
|
||||||
|
Installing the IVSHMEM Driver
|
||||||
|
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||||
|
|
||||||
|
Since B6 the host installer available on the official Looking Glass website
|
||||||
|
comes with the IVSHMEM driver and will install this for you. If you are running
|
||||||
|
an older verison of Looking Glass please refer to the documentation for your
|
||||||
|
version.
|
||||||
|
|
||||||
|
.. _host_install_service:
|
||||||
|
|
||||||
|
Installing the Looking Glass Service
|
||||||
|
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||||
|
|
||||||
|
After installing your IVSHMEM driver, we can now install the Looking Glass Host
|
||||||
|
onto our Windows Virtual Machine.
|
||||||
|
|
||||||
|
1. First, run ``looking-glass-host-setup.exe`` as an administrator
|
||||||
|
(:ref:`Why? <faq_host_admin_privs>`)
|
||||||
|
2. You will be greeted by an intro screen. Press ``Next`` to continue.
|
||||||
|
3. You are presented with the |license| license. Please read and agree to the
|
||||||
|
license by pressing ``Agree``.
|
||||||
|
4. You can change the install path if you wish, otherwise press ``Next`` to
|
||||||
|
continue.
|
||||||
|
5. You may enable or disable options on this screen to configure the
|
||||||
|
installation. The default values are recommended for most users.
|
||||||
|
Press ``Install`` to begin installation.
|
||||||
|
6. After a few moments, installation will complete, and you will have a
|
||||||
|
running instance of Looking Glass. If you experience failures, you can
|
||||||
|
see them in the install log appearing in the middle of the window.
|
||||||
|
7. Press ``Close`` to exit the installer.
|
||||||
|
|
||||||
|
Command line users can run ``looking-glass-host-setup.exe /S`` to execute a
|
||||||
|
silent install with default options selected. Further configuration from the
|
||||||
|
command line can be done with flags. You can list all available flags by
|
||||||
|
running ``looking-glass-host-setup.exe /?``.
|
||||||
|
|
||||||
.. _client_install:
|
.. _client_install:
|
||||||
|
|
||||||
Client
|
Client
|
||||||
@ -204,79 +269,3 @@ https://www.spice-space.org/download.html#windows-binaries.
|
|||||||
<address type="virtio-serial" controller="0" bus="0" port="1"/>
|
<address type="virtio-serial" controller="0" bus="0" port="1"/>
|
||||||
</channel>
|
</channel>
|
||||||
<!-- No need to add a VirtIO Serial device, it will be added automatically -->
|
<!-- No need to add a VirtIO Serial device, it will be added automatically -->
|
||||||
|
|
||||||
.. _host_install:
|
|
||||||
|
|
||||||
Host
|
|
||||||
----
|
|
||||||
|
|
||||||
The Looking Glass Host captures frames from the guest OS using a capture API,
|
|
||||||
and sends them to the :ref:`Client <client_install>`—be it on the host OS (hypervisor)
|
|
||||||
or another Virtual Machine—through a low-latency transfer protocol over shared
|
|
||||||
memory.
|
|
||||||
|
|
||||||
You can get the host program in two ways:
|
|
||||||
|
|
||||||
- Download a pre-built binary from https://looking-glass.io/downloads
|
|
||||||
(**recommended**)
|
|
||||||
|
|
||||||
- Download the source code as described in :ref:`building`, then
|
|
||||||
:ref:`build the host <host_building>`.
|
|
||||||
|
|
||||||
.. _host_install_windows:
|
|
||||||
|
|
||||||
Windows
|
|
||||||
~~~~~~~
|
|
||||||
|
|
||||||
To begin, you must first run the Windows VM with the changes noted above in
|
|
||||||
either the :ref:`client_libvirt_configuration` or :ref:`client_qemu_commands`
|
|
||||||
sections.
|
|
||||||
|
|
||||||
.. _installing_the_ivshmem_driver:
|
|
||||||
|
|
||||||
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.
|
|
||||||
|
|
||||||
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.
|
|
||||||
|
|
||||||
If you encounter warnings or errors about driver signatures, ensure secure boot
|
|
||||||
is turned off in the bios/UEFI settings of your virtual machine.
|
|
||||||
|
|
||||||
.. _host_install_service:
|
|
||||||
|
|
||||||
Installing the Looking Glass Service
|
|
||||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
||||||
|
|
||||||
After installing your IVSHMEM driver, we can now install the Looking Glass Host
|
|
||||||
onto our Windows Virtual Machine.
|
|
||||||
|
|
||||||
1. First, run ``looking-glass-host-setup.exe`` as an administrator
|
|
||||||
(:ref:`Why? <faq_host_admin_privs>`)
|
|
||||||
2. You will be greeted by an intro screen. Press ``Next`` to continue.
|
|
||||||
3. You are presented with the |license| license. Please read and agree to the
|
|
||||||
license by pressing ``Agree``.
|
|
||||||
4. You can change the install path if you wish, otherwise press ``Next`` to
|
|
||||||
continue.
|
|
||||||
5. You may enable or disable options on this screen to configure the
|
|
||||||
installation. The default values are recommended for most users.
|
|
||||||
Press ``Install`` to begin installation.
|
|
||||||
6. After a few moments, installation will complete, and you will have a
|
|
||||||
running instance of Looking Glass. If you experience failures, you can
|
|
||||||
see them in the install log appearing in the middle of the window.
|
|
||||||
7. Press ``Close`` to exit the installer.
|
|
||||||
|
|
||||||
Command line users can run ``looking-glass-host-setup.exe /S`` to execute a
|
|
||||||
silent install with default options selected. Further configuration from the
|
|
||||||
command line can be done with flags. You can list all available flags by
|
|
||||||
running ``looking-glass-host-setup.exe /?``.
|
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user