update pvenode.1-synopsis.adoc

[pve-docs.git] / pvenode.adoc

ifdef::manvolnum[]
pvenode(1)
==========
:pve-toplevel:

NAME
----

pvenode - Proxmox VE Node Management

SYNOPSIS
--------

include::pvenode.1-synopsis.adoc[]

DESCRIPTION
-----------
endif::manvolnum[]

ifndef::manvolnum[]
Proxmox Node Management
=======================
:pve-toplevel:
endif::manvolnum[]

The {PVE} node management tool (`pvenode`) allows to control node specific
settings and resources.

Currently `pvenode` allows to set a node's description and to manage
the node's SSL certificates used for the API and the web GUI through `pveproxy`.

EXAMPLES
--------
`pvenode cert set certificate.crt certificate.key -force`

Install an externally provided certificate. Both files need to be PEM encoded.
`certificate.key` contains the private key and `certificate.crt` contains the
whole certificate chain.

-----
pvenode acme account register default mail@example.invalid
pvenode config set --acme domains=example.invalid
pvenode acme cert order
systemctl restart pveproxy
-----

Setup ACME account and order a certificate for local node.

// TODO: extend and improve chapter!

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