[Spice-devel] [spice-space-pages PATCH] Spice Proxy documentation

[Christophe Fergeau]

On Mon, Mar 06, 2017 at 09:42:13AM -0500, Frediano Ziglio wrote:
> > 
> > Signed-off-by: Uri Lublin <uril at redhat.com>
> > ---
> >  proxy.rst | 102
> >  ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
> >  1 file changed, 102 insertions(+)
> >  create mode 100644 proxy.rst
> > 
> > diff --git a/proxy.rst b/proxy.rst
> > new file mode 100644
> > index 0000000..9824a15
> > --- /dev/null
> > +++ b/proxy.rst
> > @@ -0,0 +1,102 @@
> > +Spice Proxy
> > +###########
> > +
> > +:slug: spice-proxy
> > +:modified: 2017-03-05 10:00
> 
> Is not git enough? These fields tend to not get updated at the end.
> 
> > +
> > +Introduction
> > +++++++++++++
> > +
> > +Spice client (remote-viewer) supports connecting to the server via an http
> > proxy.
> > +This may be desirable for cases when the client does not have direct access
> > +to the server.
> > +
> > +Configuring the Client
> > +++++++++++++++++++++++
> > +
> > +Proxy Format
> > +^^^^^^^^^^^^
> > +[protocol://]proxy-host[:proxy-port]
> > +
> > +.. code-block:: sh
> > +
> > +   for example: http://10.0.15.50:3128
> > +
> > +There are two ways to tell the client to connect via an http proxy:
> > +
> > +SPICE_PROXY environment variable
> > +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
> > +A SPICE_PROXY environment variable tells remote-viewer
> > +to connect to the spice-server via a proxy-server
> > +
> > +.. code-block:: sh
> > +
> > +   export SPICE_PROXY="http://10.0.15.50:3128"

I forgot, can it use "http_proxy" or not?

> > +
> > +proxy key in a vv-file (under [virt-viewer])
> > +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
> > +A proxy key in a vv-file tells the remote-viewer to
> > +connect to the spice-server via a proxy-server
> > +
> > +.. code-block:: sh
> > +
> > +   [virt-viewer]
> > +   proxy=http://10.0.15.50:3128
> > +
> > +
> > +Configuring the proxy server (squid as an example)
> > +++++++++++++++++++++++++++++++++++++++++++++++++++
> > +Squid (squid-cache.org) can be used as a proxy server.
> > +
> > +This is just an example.
> > +There are other configurations possible, and other proxy
> > +servers.
> > +Configuration should be done according to requirements.
> > +Firewall, if exists, may need to be configured as well.
> > +
> > +
> > +Installation (Fedora)
> > +^^^^^^^^^^^^^^^^^^^^^
> > +On Fedora it can be installed via dnf, e.g.
> > +
> > +.. code-block:: sh
> > +
> > +   dnf install squid

I would not document the installation process as it's really
straightforward ;)


Christophe
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 801 bytes
Desc: not available
URL: <https://lists.freedesktop.org/archives/spice-devel/attachments/20170306/95cba51d/attachment.sig>