docs: add proxmox-backup service description

This commit is contained in:
Dietmar Maurer 2021-02-13 09:48:21 +01:00
parent b3c2c57897
commit 92eaec53db
3 changed files with 54 additions and 0 deletions

View File

@ -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.

View File

@ -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

View File

@ -6,3 +6,9 @@ Service Daemons
.. include:: proxmox-backup-proxy/description.rst
``proxmox-backup``
~~~~~~~~~~~~~~~~~~
.. include:: proxmox-backup/description.rst