* [pbs-devel] [PATCH proxmox-backup 1/2] docs: add node.cfg man page
@ 2024-10-10 13:26 Gabriel Goller
2024-10-10 13:26 ` [pbs-devel] [PATCH proxmox-backup 2/2] docs: fix warnings in external-metric-server page Gabriel Goller
0 siblings, 1 reply; 2+ messages in thread
From: Gabriel Goller @ 2024-10-10 13:26 UTC (permalink / raw)
To: pbs-devel
Add man page for the node.cfg config file.
Signed-off-by: Gabriel Goller <g.goller@proxmox.com>
---
Note: for some reason the node.cfg implementation is still in
`proxmox_backup::config` and not in `pbs_config`, where all the other
configs reside – that's why I refrained from generating the
`SectionConfig` output.
docs/Makefile | 15 +++++------
docs/conf.py | 1 +
docs/config/node/format.rst | 49 ++++++++++++++++++++++++++++++++++++
docs/config/node/man5.rst | 18 +++++++++++++
docs/configuration-files.rst | 8 ++++++
5 files changed, 84 insertions(+), 7 deletions(-)
create mode 100644 docs/config/node/format.rst
create mode 100644 docs/config/node/man5.rst
diff --git a/docs/Makefile b/docs/Makefile
index d23796b7c5f8..3829d8bceb91 100644
--- a/docs/Makefile
+++ b/docs/Makefile
@@ -36,18 +36,19 @@ MAN1_PAGES := \
pbs2to3.1 \
MAN5_PAGES := \
- media-pool.cfg.5 \
- tape.cfg.5 \
- tape-job.cfg.5 \
acl.cfg.5 \
- user.cfg.5 \
- remote.cfg.5 \
- sync.cfg.5 \
- verification.cfg.5 \
datastore.cfg.5 \
domains.cfg.5 \
+ media-pool.cfg.5 \
+ node.cfg.5 \
notifications.cfg.5 \
notifications-priv.cfg.5 \
+ remote.cfg.5 \
+ sync.cfg.5 \
+ tape.cfg.5 \
+ tape-job.cfg.5 \
+ user.cfg.5 \
+ verification.cfg.5 \
PRUNE_SIMULATOR_FILES := \
prune-simulator/index.html \
diff --git a/docs/conf.py b/docs/conf.py
index fba726295c38..92ff838684ac 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -108,6 +108,7 @@ man_pages = [
('config/datastore/man5', 'datastore.cfg', 'Datastore 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/node/man5', 'node.cfg', 'Node Configuration', [author], 5),
('config/remote/man5', 'remote.cfg', 'Remote Server 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),
diff --git a/docs/config/node/format.rst b/docs/config/node/format.rst
new file mode 100644
index 000000000000..f5ad5d8138e4
--- /dev/null
+++ b/docs/config/node/format.rst
@@ -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.
diff --git a/docs/config/node/man5.rst b/docs/config/node/man5.rst
new file mode 100644
index 000000000000..fbdaf3b0ae1e
--- /dev/null
+++ b/docs/config/node/man5.rst
@@ -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
diff --git a/docs/configuration-files.rst b/docs/configuration-files.rst
index b296e11905bb..5fabf48c4f8f 100644
--- a/docs/configuration-files.rst
+++ b/docs/configuration-files.rst
@@ -67,6 +67,14 @@ Options
.. include:: config/media-pool/config.rst
+``node.cfg``
+~~~~~~~~~~~~~~~~~~
+
+Options
+^^^^^^^
+
+.. include:: config/node/format.rst
+
.. _notifications.cfg:
``notifications.cfg``
--
2.39.5
_______________________________________________
pbs-devel mailing list
pbs-devel@lists.proxmox.com
https://lists.proxmox.com/cgi-bin/mailman/listinfo/pbs-devel
^ permalink raw reply [flat|nested] 2+ messages in thread
* [pbs-devel] [PATCH proxmox-backup 2/2] docs: fix warnings in external-metric-server page
2024-10-10 13:26 [pbs-devel] [PATCH proxmox-backup 1/2] docs: add node.cfg man page Gabriel Goller
@ 2024-10-10 13:26 ` Gabriel Goller
0 siblings, 0 replies; 2+ messages in thread
From: Gabriel Goller @ 2024-10-10 13:26 UTC (permalink / raw)
To: pbs-devel
Rename external-metric-server page and fix code-block to remove some
warnings.
Signed-off-by: Gabriel Goller <g.goller@proxmox.com>
---
...c_server.rst => external-metric-server.rst} | 18 ++++++++----------
docs/sysadmin.rst | 2 +-
2 files changed, 9 insertions(+), 11 deletions(-)
rename docs/{external_metric_server.rst => external-metric-server.rst} (91%)
diff --git a/docs/external_metric_server.rst b/docs/external-metric-server.rst
similarity index 91%
rename from docs/external_metric_server.rst
rename to docs/external-metric-server.rst
index 097a8cc3a1c0..f65082cc4976 100644
--- a/docs/external_metric_server.rst
+++ b/docs/external-metric-server.rst
@@ -1,5 +1,3 @@
-.. _external_metric_server:
-
External Metric Server
----------------------
@@ -44,14 +42,14 @@ necessary.
Here is an example configuration for InfluxDB (on your InfluxDB server):
-----
-[[udp]]
- enabled = true
- bind-address = "0.0.0.0:8089"
- database = "proxmox"
- batch-size = 1000
- batch-timeout = "1s"
-----
+.. code-block:: console
+
+ [[udp]]
+ enabled = true
+ bind-address = "0.0.0.0:8089"
+ database = "proxmox"
+ batch-size = 1000
+ batch-timeout = "1s"
With this configuration, the InfluxDB server listens on all IP addresses on
port 8089, and writes the data in the *proxmox* database.
diff --git a/docs/sysadmin.rst b/docs/sysadmin.rst
index d42b6a9b2af1..ec124d41a857 100644
--- a/docs/sysadmin.rst
+++ b/docs/sysadmin.rst
@@ -30,7 +30,7 @@ please refer to the standard Debian documentation.
.. include:: certificate-management.rst
-.. include:: external_metric_server.rst
+.. include:: external-metric-server.rst
.. include:: services.rst
--
2.39.5
_______________________________________________
pbs-devel mailing list
pbs-devel@lists.proxmox.com
https://lists.proxmox.com/cgi-bin/mailman/listinfo/pbs-devel
^ permalink raw reply [flat|nested] 2+ messages in thread
end of thread, other threads:[~2024-10-10 13:26 UTC | newest]
Thread overview: 2+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2024-10-10 13:26 [pbs-devel] [PATCH proxmox-backup 1/2] docs: add node.cfg man page Gabriel Goller
2024-10-10 13:26 ` [pbs-devel] [PATCH proxmox-backup 2/2] docs: fix warnings in external-metric-server page Gabriel Goller
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox