From 92eaec53db5a920af2c17e97037a7b225332d5ad Mon Sep 17 00:00:00 2001 From: Dietmar Maurer Date: Sat, 13 Feb 2021 09:48:21 +0100 Subject: [PATCH] docs: add proxmox-backup service description --- docs/proxmox-backup/description.rst | 7 +++++ docs/proxmox-backup/man1.rst | 41 +++++++++++++++++++++++++++++ docs/services.rst | 6 +++++ 3 files changed, 54 insertions(+) create mode 100644 docs/proxmox-backup/description.rst create mode 100644 docs/proxmox-backup/man1.rst diff --git a/docs/proxmox-backup/description.rst b/docs/proxmox-backup/description.rst new file mode 100644 index 00000000..31767a32 --- /dev/null +++ b/docs/proxmox-backup/description.rst @@ -0,0 +1,7 @@ +This daemon exposes the Proxmox Backup Server management API on +``127.0.0.1:82``. It runs as ``root`` and has permission to do all +privileged operations. + +NOTE: The daemon listens to a local address only, so you cannot access +it from outside. The ``proxmox-backup-proxy`` daemon exposes the API +to the outside world. diff --git a/docs/proxmox-backup/man1.rst b/docs/proxmox-backup/man1.rst new file mode 100644 index 00000000..3893f646 --- /dev/null +++ b/docs/proxmox-backup/man1.rst @@ -0,0 +1,41 @@ +========================== +proxmox-backup +========================== + +.. include:: ../epilog.rst + +------------------------------------------------------------- +Proxmox Backup Local API Server +------------------------------------------------------------- + +:Author: |AUTHOR| +:Version: Version |VERSION| +:Manual section: 1 + + +Synopsis +========== + +This daemon is normally started and managed as ``systemd`` service:: + + systemctl start proxmox-backup + + systemctl stop proxmox-backup + + systemctl status proxmox-backup + +For debugging, you can start the daemon in foreground using:: + + proxmox-backup-api + +.. NOTE:: You need to stop the service before starting the daemon in + foreground. + + +Description +============ + +.. include:: description.rst + + +.. include:: ../pbs-copyright.rst diff --git a/docs/services.rst b/docs/services.rst index fa8600b5..eb13925c 100644 --- a/docs/services.rst +++ b/docs/services.rst @@ -6,3 +6,9 @@ Service Daemons .. include:: proxmox-backup-proxy/description.rst + +``proxmox-backup`` +~~~~~~~~~~~~~~~~~~ + +.. include:: proxmox-backup/description.rst +