[Spice-devel] [spice-server v2 1/2] docs: Add documentation for the streaming device

[Jonathon Jongsma]

Acked-by: Jonathon Jongsma <jjongsma at redhat.com>


On Mon, 2018-08-13 at 12:18 +0200, Christophe Fergeau wrote:
> Signed-off-by: Christophe Fergeau <cfergeau at redhat.com>
> ---
>  docs/manual/manual.txt | 51
> ++++++++++++++++++++++++++++++++++++++++++
>  1 file changed, 51 insertions(+)
> 
> diff --git a/docs/manual/manual.txt b/docs/manual/manual.txt
> index 40d080d9f..99f6a5c84 100644
> --- a/docs/manual/manual.txt
> +++ b/docs/manual/manual.txt
> @@ -544,6 +544,57 @@ which are described when running remote-viewer
> with `--help-spice`.
>  To get USB redirection working on Windows clients, you need to
> install
>  http://www.spice-space.org/download/windows/usbdk/[UsbDk]
>  
> +[[streamingagent]]
> +Streaming Agent
> +===============
> +
> +The SPICE streaming agent allows to send an encoded video stream of
> the guest
> +desktop to the client.
> +
> +The streaming agent is a daemon/service running in the guest OS so
> it must be
> +installed if it does not yet exist on the guest system.  It relies
> on a
> +dedicated spiceport char device to achieve communication between the
> guest and
> +the host.  This device must be added to the virtual machine as
> described below
> +for the streaming agent to work in the guest.
> +
> +Configuration
> +-------------
> +
> +.Using virt-manager
> +
> +The needed device can be added from the virtual machine
> +details. Click on "Add hardware" and then add a "Channel" device
> with
> +type "Spice port (spiceport)". The port should be named
> +`org.spice-space.stream.0`, and the channel should also be
> +`org.spice-space.stream.0`.
> +
> +.Using libvirt
> +
> +Two distinct devices must be added:
> +
> +* http://libvirt.org/formatdomain.html#elementsControllers[a virtio
> serial
> +  device] if there is not one yet in the domain definition
> +* http://libvirt.org/formatdomain.html#elementsCharSpiceport[a
> spiceport channel]
> +
> +[source,xml]
> +<devices>
> +    <controller type='virtio-serial' index='0'/>
> +    <channel type='spiceport'>
> +        <source channel='org.spice-space.stream.0'/>
> +        <target type='virtio' name='org.spice-space.stream.0'/>
> +    </channel>
> +</devices>
> +
> +.Using QEMU
> +
> +Adding the following parameters to your QEMU command line will
> enable
> +the needed devices for agent support in the guest OS:
> +
> +[source,sh]
> +-device virtserialport,bus=virtio-
> serial0.0,nr=1,chardev=charchannel1,id=channel1,name=org.spice-
> space.stream.0 \
> +-chardev spiceport,name=org.spice-space.stream.0,id=charchannel1
> +
> +
>  CAC smartcard redirection
>  =========================
>