mirror of
https://git.proxmox.com/git/pve-docs
synced 2025-04-29 20:02:47 +00:00
add spiceproxy man page
This commit is contained in:
parent
15d7842ca3
commit
2d8f1c9267
5
Makefile
5
Makefile
@ -20,6 +20,7 @@ SERVICE_LIST= \
|
|||||||
pvestatd \
|
pvestatd \
|
||||||
pmxcfs \
|
pmxcfs \
|
||||||
pveproxy \
|
pveproxy \
|
||||||
|
spiceproxy \
|
||||||
pvedaemon
|
pvedaemon
|
||||||
|
|
||||||
CONFIG_LIST=datacenter.cfg qm.conf pct.conf
|
CONFIG_LIST=datacenter.cfg qm.conf pct.conf
|
||||||
@ -80,6 +81,10 @@ PVE_ADMIN_GUIDE_SOURCES= \
|
|||||||
${QM_MAN1_SOURCES} \
|
${QM_MAN1_SOURCES} \
|
||||||
${QMRESTORE_MAN1_SOURCES} \
|
${QMRESTORE_MAN1_SOURCES} \
|
||||||
${HA_MANAGER_MAN1_SOURCES} \
|
${HA_MANAGER_MAN1_SOURCES} \
|
||||||
|
${PVESTATD_MAN8_SOURCES} \
|
||||||
|
${PVEDAEMON_MAN8_SOURCES} \
|
||||||
|
${PVEPROXY_MAN8_SOURCES} \
|
||||||
|
${SPICEPROXY_MAN8_SOURCES} \
|
||||||
${PVE_HA_CRM_MAN8_SOURCES} \
|
${PVE_HA_CRM_MAN8_SOURCES} \
|
||||||
${PVE_HA_LRM_MAN8_SOURCES} \
|
${PVE_HA_LRM_MAN8_SOURCES} \
|
||||||
${PVEAM_SOURCES} \
|
${PVEAM_SOURCES} \
|
||||||
|
@ -45,6 +45,7 @@ Service Daemons
|
|||||||
| pvedaemon | pvedaemon.service |link:pvedaemon.8.html[pvedaemon.8]
|
| pvedaemon | pvedaemon.service |link:pvedaemon.8.html[pvedaemon.8]
|
||||||
| pveproxy | pveproxy.service |link:pveproxy.8.html[pveproxy.8]
|
| pveproxy | pveproxy.service |link:pveproxy.8.html[pveproxy.8]
|
||||||
| pvestatd | pvestatd.service |link:pvestatd.8.html[pvestatd.8]
|
| pvestatd | pvestatd.service |link:pvestatd.8.html[pvestatd.8]
|
||||||
|
| spiceproxy | spiceproxy.service |link:spiceproxy.8.html[spiceproxy.8]
|
||||||
| pve-ha-crm | pve-ha-crm.service |link:pve-ha-crm.8.html[pve-ha-crm.8]
|
| pve-ha-crm | pve-ha-crm.service |link:pve-ha-crm.8.html[pve-ha-crm.8]
|
||||||
| pve-ha-lrm | pve-ha-lrm.service |link:pve-ha-lrm.8.html[pve-ha-lrm.8]
|
| pve-ha-lrm | pve-ha-lrm.service |link:pve-ha-lrm.8.html[pve-ha-lrm.8]
|
||||||
| pve-firewall | pve-firewall.service |link:pve-firewall.8.html[pve-firewall.8]
|
| pve-firewall | pve-firewall.service |link:pve-firewall.8.html[pve-firewall.8]
|
||||||
|
@ -45,6 +45,8 @@ include::pveproxy.adoc[]
|
|||||||
|
|
||||||
include::pvestatd.adoc[]
|
include::pvestatd.adoc[]
|
||||||
|
|
||||||
|
include::spiceproxy.adoc[]
|
||||||
|
|
||||||
:leveloffset: 0
|
:leveloffset: 0
|
||||||
|
|
||||||
|
|
||||||
@ -149,6 +151,7 @@ include::pve-firewall.8-synopsis.adoc[]
|
|||||||
include::pvedaemon.8-synopsis.adoc[]
|
include::pvedaemon.8-synopsis.adoc[]
|
||||||
|
|
||||||
:leveloffset: 0
|
:leveloffset: 0
|
||||||
|
|
||||||
*pveproxy* - {pve} API Proxy Daemon
|
*pveproxy* - {pve} API Proxy Daemon
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
@ -166,6 +169,15 @@ include::pvestatd.8-synopsis.adoc[]
|
|||||||
|
|
||||||
:leveloffset: 0
|
:leveloffset: 0
|
||||||
|
|
||||||
|
*spiceproxy* - SPICE Proxy Service
|
||||||
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
:leveloffset: 1
|
||||||
|
|
||||||
|
include::spiceproxy.8-synopsis.adoc[]
|
||||||
|
|
||||||
|
:leveloffset: 0
|
||||||
|
|
||||||
*pmxcfs* - Proxmox Cluster File System
|
*pmxcfs* - Proxmox Cluster File System
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
@ -103,6 +103,11 @@ PVEPROXY_MAN8_SOURCES= \
|
|||||||
pveproxy.8-synopsis.adoc \
|
pveproxy.8-synopsis.adoc \
|
||||||
${PVE_COMMON_DOC_SOURCES}
|
${PVE_COMMON_DOC_SOURCES}
|
||||||
|
|
||||||
|
SPICEPROXY_MAN8_SOURCES= \
|
||||||
|
spiceproxy.adoc \
|
||||||
|
spiceproxy.8-synopsis.adoc \
|
||||||
|
${PVE_COMMON_DOC_SOURCES}
|
||||||
|
|
||||||
PMXCFS_MAN8_SOURCES= \
|
PMXCFS_MAN8_SOURCES= \
|
||||||
pmxcfs.adoc \
|
pmxcfs.adoc \
|
||||||
pmxcfs.8-cli.adoc \
|
pmxcfs.8-cli.adoc \
|
||||||
@ -191,6 +196,10 @@ pveproxy.8: ${PVEPROXY_MAN8_SOURCES}
|
|||||||
a2x ${A2X_MAN8_OPTIONS} pveproxy.adoc
|
a2x ${A2X_MAN8_OPTIONS} pveproxy.adoc
|
||||||
test -n "$${NOVIEW}" || man -l $@
|
test -n "$${NOVIEW}" || man -l $@
|
||||||
|
|
||||||
|
spiceproxy.8: ${SPICEPROXY_MAN8_SOURCES}
|
||||||
|
a2x ${A2X_MAN8_OPTIONS} spiceproxy.adoc
|
||||||
|
test -n "$${NOVIEW}" || man -l $@
|
||||||
|
|
||||||
pmxcfs.8: ${PMXCFS_MAN8_SOURCES}
|
pmxcfs.8: ${PMXCFS_MAN8_SOURCES}
|
||||||
a2x ${A2X_MAN8_OPTIONS} pmxcfs.adoc
|
a2x ${A2X_MAN8_OPTIONS} pmxcfs.adoc
|
||||||
test -n "$${NOVIEW}" || man -l $@
|
test -n "$${NOVIEW}" || man -l $@
|
||||||
|
46
spiceproxy.8-synopsis.adoc
Normal file
46
spiceproxy.8-synopsis.adoc
Normal file
@ -0,0 +1,46 @@
|
|||||||
|
*spiceproxy* `<COMMAND> [ARGS] [OPTIONS]`
|
||||||
|
|
||||||
|
*spiceproxy help* `[<cmd>]` `[OPTIONS]`
|
||||||
|
|
||||||
|
Get help about specified command.
|
||||||
|
|
||||||
|
`<cmd>` `string` ::
|
||||||
|
|
||||||
|
Command name
|
||||||
|
|
||||||
|
`-verbose` `boolean` ::
|
||||||
|
|
||||||
|
Verbose output format.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
*spiceproxy restart*
|
||||||
|
|
||||||
|
Restart the daemon (or start if not running).
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
*spiceproxy start* `[OPTIONS]`
|
||||||
|
|
||||||
|
Start the daemon.
|
||||||
|
|
||||||
|
`-debug` `boolean` (default=`0`)::
|
||||||
|
|
||||||
|
Debug mode - stay in foreground
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
*spiceproxy status*
|
||||||
|
|
||||||
|
Get daemon status.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
*spiceproxy stop*
|
||||||
|
|
||||||
|
Stop the daemon.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
48
spiceproxy.adoc
Normal file
48
spiceproxy.adoc
Normal file
@ -0,0 +1,48 @@
|
|||||||
|
ifdef::manvolnum[]
|
||||||
|
PVE({manvolnum})
|
||||||
|
================
|
||||||
|
include::attributes.txt[]
|
||||||
|
|
||||||
|
NAME
|
||||||
|
----
|
||||||
|
|
||||||
|
spiceproxy - SPICE Proxy Service
|
||||||
|
|
||||||
|
|
||||||
|
SYNOPSYS
|
||||||
|
--------
|
||||||
|
|
||||||
|
include::spiceproxy.8-synopsis.adoc[]
|
||||||
|
|
||||||
|
DESCRIPTION
|
||||||
|
-----------
|
||||||
|
endif::manvolnum[]
|
||||||
|
|
||||||
|
ifndef::manvolnum[]
|
||||||
|
SPICE Proxy Service
|
||||||
|
===================
|
||||||
|
include::attributes.txt[]
|
||||||
|
endif::manvolnum[]
|
||||||
|
|
||||||
|
http://www.spice-space.org[SPICE] (the Simple Protocol for Independent
|
||||||
|
Computing Environments) is an open remote computing solution,
|
||||||
|
providing client access to remote displays and devices (e.g. keyboard,
|
||||||
|
mouse, audio). The main use case is to get remote access to virtual
|
||||||
|
machines and container.
|
||||||
|
|
||||||
|
This daemon listens on TCP port 3128, and implements an HTTP proxy to
|
||||||
|
forward 'CONNECT' request from the SPICE client to the correct {pve}
|
||||||
|
VM. It runs as user 'www-data' and has very limited permissions.
|
||||||
|
|
||||||
|
|
||||||
|
Host based Access Control
|
||||||
|
-------------------------
|
||||||
|
|
||||||
|
It is possible to configure "apache2" like access control
|
||||||
|
lists. Values are read from file '/etc/default/pveproxy'.
|
||||||
|
See 'pveproxy' documentation for details.
|
||||||
|
|
||||||
|
|
||||||
|
ifdef::manvolnum[]
|
||||||
|
include::pve-copyright.adoc[]
|
||||||
|
endif::manvolnum[]
|
Loading…
Reference in New Issue
Block a user