mirror of
https://git.proxmox.com/git/proxmox-backup
synced 2025-07-11 20:11:47 +00:00
docs: add node.cfg man page
Add man page for the node.cfg config file. Signed-off-by: Gabriel Goller <g.goller@proxmox.com> [ TL: pull out sorting of synopsis file list to separate commit ] Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
This commit is contained in:
parent
45c9383e94
commit
3c9fe358cc
@ -40,6 +40,7 @@ MAN5_PAGES := \
|
|||||||
datastore.cfg.5 \
|
datastore.cfg.5 \
|
||||||
domains.cfg.5 \
|
domains.cfg.5 \
|
||||||
media-pool.cfg.5 \
|
media-pool.cfg.5 \
|
||||||
|
node.cfg.5 \
|
||||||
notifications-priv.cfg.5 \
|
notifications-priv.cfg.5 \
|
||||||
notifications.cfg.5 \
|
notifications.cfg.5 \
|
||||||
remote.cfg.5 \
|
remote.cfg.5 \
|
||||||
|
@ -108,6 +108,7 @@ man_pages = [
|
|||||||
('config/datastore/man5', 'datastore.cfg', 'Datastore Configuration', [author], 5),
|
('config/datastore/man5', 'datastore.cfg', 'Datastore Configuration', [author], 5),
|
||||||
('config/domains/man5', 'domains.cfg', 'Realm Configuration', [author], 5),
|
('config/domains/man5', 'domains.cfg', 'Realm Configuration', [author], 5),
|
||||||
('config/media-pool/man5', 'media-pool.cfg', 'Media Pool Configuration', [author], 5),
|
('config/media-pool/man5', 'media-pool.cfg', 'Media Pool Configuration', [author], 5),
|
||||||
|
('config/node/man5', 'node.cfg', 'Node Configuration', [author], 5),
|
||||||
('config/remote/man5', 'remote.cfg', 'Remote Server Configuration', [author], 5),
|
('config/remote/man5', 'remote.cfg', 'Remote Server Configuration', [author], 5),
|
||||||
('config/sync/man5', 'sync.cfg', 'Synchronization Job Configuration', [author], 5),
|
('config/sync/man5', 'sync.cfg', 'Synchronization Job Configuration', [author], 5),
|
||||||
('config/tape-job/man5', 'tape-job.cfg', 'Tape Job Configuration', [author], 5),
|
('config/tape-job/man5', 'tape-job.cfg', 'Tape Job Configuration', [author], 5),
|
||||||
|
49
docs/config/node/format.rst
Normal file
49
docs/config/node/format.rst
Normal file
@ -0,0 +1,49 @@
|
|||||||
|
The file contains these options:
|
||||||
|
|
||||||
|
:acme: The ACME account to use on this node.
|
||||||
|
|
||||||
|
:acmedomain0: ACME domain.
|
||||||
|
|
||||||
|
:acmedomain1: ACME domain.
|
||||||
|
|
||||||
|
:acmedomain2: ACME domain.
|
||||||
|
|
||||||
|
:acmedomain3: ACME domain.
|
||||||
|
|
||||||
|
:acmedomain4: ACME domain.
|
||||||
|
|
||||||
|
:http-proxy: Set proxy for apt and subscription checks.
|
||||||
|
|
||||||
|
:email-from: Fallback email from which notifications will be sent.
|
||||||
|
|
||||||
|
:ciphers-tls-1.3: List of TLS ciphers for TLS 1.3 that will be used by the proxy. Colon-separated and in descending priority (https://docs.openssl.org/master/man1/openssl-ciphers/). (Proxy has to be restarted for changes to take effect.)
|
||||||
|
|
||||||
|
:ciphers-tls-1.2: List of TLS ciphers for TLS <= 1.2 that will be used by the proxy. Colon-separated and in descending priority (https://docs.openssl.org/master/man1/openssl-ciphers/). (Proxy has to be restarted for changes to take effect.)
|
||||||
|
|
||||||
|
:default-lang: Default language used in the GUI.
|
||||||
|
|
||||||
|
:description: Node description.
|
||||||
|
|
||||||
|
:task-log-max-days: Maximum days to keep task logs.
|
||||||
|
|
||||||
|
For example:
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
|
acme: local
|
||||||
|
acmedomain0: first.domain.com
|
||||||
|
acmedomain1: second.domain.com
|
||||||
|
acmedomain2: third.domain.com
|
||||||
|
acmedomain3: fourth.domain.com
|
||||||
|
acmedomain4: fifth.domain.com
|
||||||
|
http-proxy: internal.proxy.com
|
||||||
|
email-from: proxmox@mail.com
|
||||||
|
ciphers-tls-1.3: TLS_AES_128_GCM_SHA256:TLS_AES_128_CCM_8_SHA256:TLS_CHACHA20_POLY1305_SHA256
|
||||||
|
ciphers-tls-1.2: RSA_WITH_AES_128_CCM:DHE_RSA_WITH_AES_128_CCM
|
||||||
|
default-lang: en
|
||||||
|
description: Primary PBS instance
|
||||||
|
task-log-max-days: 30
|
||||||
|
|
||||||
|
|
||||||
|
You can use the ``proxmox-backup-manager node`` command to manipulate
|
||||||
|
this file.
|
18
docs/config/node/man5.rst
Normal file
18
docs/config/node/man5.rst
Normal file
@ -0,0 +1,18 @@
|
|||||||
|
:orphan:
|
||||||
|
|
||||||
|
========
|
||||||
|
node.cfg
|
||||||
|
========
|
||||||
|
|
||||||
|
Description
|
||||||
|
===========
|
||||||
|
|
||||||
|
The file /etc/proxmox-backup/node.cfg is a configuration file for Proxmox
|
||||||
|
Backup Server. It contains the general configuration regarding this node.
|
||||||
|
|
||||||
|
Options
|
||||||
|
=======
|
||||||
|
|
||||||
|
.. include:: format.rst
|
||||||
|
|
||||||
|
.. include:: ../../pbs-copyright.rst
|
@ -67,6 +67,14 @@ Options
|
|||||||
|
|
||||||
.. include:: config/media-pool/config.rst
|
.. include:: config/media-pool/config.rst
|
||||||
|
|
||||||
|
``node.cfg``
|
||||||
|
~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
Options
|
||||||
|
^^^^^^^
|
||||||
|
|
||||||
|
.. include:: config/node/format.rst
|
||||||
|
|
||||||
.. _notifications.cfg:
|
.. _notifications.cfg:
|
||||||
|
|
||||||
``notifications.cfg``
|
``notifications.cfg``
|
||||||
|
Loading…
Reference in New Issue
Block a user