minor fixup

[pve-docs.git] / pveproxy.adoc

diff --git a/pveproxy.adoc b/pveproxy.adoc
index ca320893e970cb2ad423f2f2aee56364b4214945..5b831066f00a5ae282da85760c61ccf79677e827 100644 (file)
--- a/pveproxy.adoc
+++ b/pveproxy.adoc
@@ -1,7 +1,7 @@
 ifdef::manvolnum[]
 ifdef::manvolnum[]

-PVE({manvolnum})
-================
-include::attributes.txt[]
+pveproxy(8)
+===========
+:pve-toplevel:

 
 NAME
 ----
 
 NAME
 ----


@@ -9,7 +9,7 @@ NAME
 pveproxy - PVE API Proxy Daemon
 
 
 pveproxy - PVE API Proxy Daemon
 
 

-SYNOPSYS
+SYNOPSIS

 --------
 
 include::pveproxy.8-synopsis.adoc[]
 --------
 
 include::pveproxy.8-synopsis.adoc[]


@@ -19,15 +19,14 @@ DESCRIPTION
 endif::manvolnum[]
 
 ifndef::manvolnum[]
 endif::manvolnum[]
 
 ifndef::manvolnum[]

-{pve} API Proxy Daemon
-======================
-include::attributes.txt[]
+pveproxy - Proxmox VE API Proxy Daemon
+======================================

 endif::manvolnum[]
 
 This daemon exposes the whole {pve} API on TCP port 8006 using
 endif::manvolnum[]
 
 This daemon exposes the whole {pve} API on TCP port 8006 using

-HTTPS. It runs as user 'www-data' and has very limited permissions.
+HTTPS. It runs as user `www-data` and has very limited permissions.

 Operation requiring more permissions are forwarded to the local
 Operation requiring more permissions are forwarded to the local

-'pvedaemon'.
+`pvedaemon`.

 
 Requests targeted for other nodes are automatically forwarded to those
 nodes. This means that you can manage your whole cluster by connecting
 
 Requests targeted for other nodes are automatically forwarded to those
 nodes. This means that you can manage your whole cluster by connecting


@@ -36,8 +35,8 @@ to a single {pve} node.
 Host based Access Control
 -------------------------
 
 Host based Access Control
 -------------------------
 

-It is possible to configure "apache2" like access control
-lists. Values are read from file '/etc/default/pveproxy'. For example:
+It is possible to configure ``apache2''-like access control
+lists. Values are read from file `/etc/default/pveproxy`. For example:

 
 ----
 ALLOW_FROM="10.0.0.1-10.0.0.5,192.168.0.0/22"
 
 ----
 ALLOW_FROM="10.0.0.1-10.0.0.5,192.168.0.0/22"


@@ -46,9 +45,9 @@ POLICY="allow"
 ----
 
 IP addresses can be specified using any syntax understood by `Net::IP`. The
 ----
 
 IP addresses can be specified using any syntax understood by `Net::IP`. The

-name 'all' is an alias for '0/0'.
+name `all` is an alias for `0/0`.

 
 

-The default policy is 'allow'.
+The default policy is `allow`.

 
 [width="100%",options="header"]
 |===========================================================
 
 [width="100%",options="header"]
 |===========================================================


@@ -63,7 +62,7 @@ The default policy is 'allow'.
 SSL Cipher Suite
 ----------------
 
 SSL Cipher Suite
 ----------------
 

-You can define the cipher list in '/etc/default/pveproxy', for example
+You can define the cipher list in `/etc/default/pveproxy`, for example

 
  CIPHERS="HIGH:MEDIUM:!aNULL:!MD5"
 
 
  CIPHERS="HIGH:MEDIUM:!aNULL:!MD5"
 


@@ -75,17 +74,40 @@ Diffie-Hellman Parameters
 -------------------------
 
 You can define the used Diffie-Hellman parameters in
 -------------------------
 
 You can define the used Diffie-Hellman parameters in

-'/etc/default/pveproxy' by setting `DHPARAMS` to the path of a file
+`/etc/default/pveproxy` by setting `DHPARAMS` to the path of a file

 containing DH parameters in PEM format, for example
 
  DHPARAMS="/path/to/dhparams.pem"
 
 containing DH parameters in PEM format, for example
 
  DHPARAMS="/path/to/dhparams.pem"
 

-If this option is not set, the built-in 'skip2048' parameters will be
+If this option is not set, the built-in `skip2048` parameters will be

 used.
 
 NOTE: DH parameters are only used if a cipher suite utilizing the DH key
 exchange algorithm is negotiated.
 
 used.
 
 NOTE: DH parameters are only used if a cipher suite utilizing the DH key
 exchange algorithm is negotiated.
 

+Alternative HTTPS certificate
+-----------------------------
+
+By default, pveproxy uses the certificate `/etc/pve/local/pve-ssl.pem`
+(and private key `/etc/pve/local/pve-ssl.key`) for HTTPS connections.
+This certificate is signed by the cluster CA certificate, and therefor
+not trusted by browsers and operating systems by default.
+
+In order to use a different certificate and private key for HTTPS,
+store the server certificate and any needed intermediate / CA
+certificates in PEM format in the file `/etc/pve/local/pveproxy-ssl.pem`
+and the associated private key in PEM format without a password in the
+file `/etc/pve/local/pveproxy-ssl.key`.
+
+WARNING: Do not replace the automatically generated node certificate
+files in `/etc/pve/local/pve-ssl.pem` and `etc/pve/local/pve-ssl.key` or
+the cluster CA files in `/etc/pve/pve-root-ca.pem` and
+`/etc/pve/priv/pve-root-ca.key`.
+
+NOTE: There is a detailed HOWTO for configuring commercial HTTPS certificates
+on the {webwiki-url}HTTPS_Certificate_Configuration_(Version_4.x_and_newer)[wiki],
+including setup instructions for obtaining certificates from the popular free
+Let's Encrypt certificate authority.

 
 ifdef::manvolnum[]
 include::pve-copyright.adoc[]
 
 ifdef::manvolnum[]
 include::pve-copyright.adoc[]