proxmox-backup/docs/configuration-files.rst

Configuration Files
===================

All `Proxmox Backup`_ Server configuration files reside in the directory
``/etc/proxmox-backup/``.


``acl.cfg``
~~~~~~~~~~~~~~~~~

File Format
^^^^^^^^^^^

.. include:: config/acl/format.rst


Roles
^^^^^

The following roles exist:

.. include:: config/acl/roles.rst


``datastore.cfg``
~~~~~~~~~~~~~~~~~

File Format
^^^^^^^^^^^

.. include:: config/datastore/format.rst


Options
^^^^^^^

.. include:: config/datastore/config.rst

.. _domains.cfg:

``domains.cfg``
~~~~~~~~~~~~~~~

File Format
^^^^^^^^^^^

.. include:: config/domains/format.rst


Options
^^^^^^^

.. include:: config/domains/config.rst


``media-pool.cfg``
~~~~~~~~~~~~~~~~~~

File Format
^^^^^^^^^^^

.. include:: config/media-pool/format.rst


Options
^^^^^^^

.. include:: config/media-pool/config.rst

``node.cfg``
~~~~~~~~~~~~~~~~~~

Options
^^^^^^^

.. include:: config/node/format.rst

.. _notifications.cfg:

``notifications.cfg``
~~~~~~~~~~~~~~~~~~~~~

File Format
^^^^^^^^^^^

.. include:: config/notifications/format.rst


Options
^^^^^^^

.. include:: config/notifications/config.rst

.. _notifications_priv.cfg:

``notifications-priv.cfg``
~~~~~~~~~~~~~~~~~~~~~~~~~~

File Format
^^^^^^^^^^^

.. include:: config/notifications-priv/format.rst


Options
^^^^^^^

.. include:: config/notifications-priv/config.rst


``tape.cfg``
~~~~~~~~~~~~

File Format
^^^^^^^^^^^

.. include:: config/tape/format.rst


Options
^^^^^^^

.. include:: config/tape/config.rst


``tape-job.cfg``
~~~~~~~~~~~~~~~~

File Format
^^^^^^^^^^^

.. include:: config/tape-job/format.rst


Options
^^^^^^^

.. include:: config/tape-job/config.rst


``user.cfg``
~~~~~~~~~~~~

File Format
^^^^^^^^^^^

.. include:: config/user/format.rst


Options
^^^^^^^

.. include:: config/user/config.rst


``remote.cfg``
~~~~~~~~~~~~~~~~~

File Format
^^^^^^^^^^^

.. include:: config/remote/format.rst


Options
^^^^^^^

.. include:: config/remote/config.rst


``sync.cfg``
~~~~~~~~~~~~~~~~~

File Format
^^^^^^^^^^^

.. include:: config/sync/format.rst


Options
^^^^^^^

.. include:: config/sync/config.rst


``verification.cfg``
~~~~~~~~~~~~~~~~~~~~

File Format
^^^^^^^^^^^

.. include:: config/verification/format.rst


Options
^^^^^^^

.. include:: config/verification/config.rst
docs: add "Configuration Files" appendix 2021-02-10 11:28:56 +01:00			`Configuration Files`
			`===================`

docs: improve the occurrence of product website hyperlinks Place hyperlinks only at the beginning of a chapter and where it makes sense, so as not to be distracted by redundant hyperlinks Signed-off-by: Alexander Zeidler <a.zeidler@proxmox.com> 2023-11-24 18:43:43 +01:00			All `Proxmox Backup`_ Server configuration files reside in the directory
docs: add "Configuration Files" appendix 2021-02-10 11:28:56 +01:00			``/etc/proxmox-backup/``.


docs: add manual page for acl.cfg 2021-02-11 13:13:34 +01:00			``acl.cfg``
			`~~~~~~~~~~~~~~~~~`

			`File Format`
			`^^^^^^^^^^^`

			`.. include:: config/acl/format.rst`


			`Roles`
			`^^^^^`

			`The following roles exist:`

			`.. include:: config/acl/roles.rst`


docs: add "Configuration Files" appendix 2021-02-10 11:28:56 +01:00			``datastore.cfg``
			`~~~~~~~~~~~~~~~~~`

			`File Format`
			`^^^^^^^^^^^`

			`.. include:: config/datastore/format.rst`


			`Options`
			`^^^^^^^`

			`.. include:: config/datastore/config.rst`
docs: add user.cfg.5 manual page 2021-02-10 16:37:27 +01:00
docs: add documentation for LDAP realms Signed-off-by: Lukas Wagner <l.wagner@proxmox.com> 2023-02-09 14:31:22 +01:00			`.. _domains.cfg:`

docs: add configuration file reference for domains.cfg Signed-off-by: Lukas Wagner <l.wagner@proxmox.com> 2023-02-09 14:31:21 +01:00			``domains.cfg``
docs: add documentation for LDAP realms Signed-off-by: Lukas Wagner <l.wagner@proxmox.com> 2023-02-09 14:31:22 +01:00			`~~~~~~~~~~~~~~~`
docs: add configuration file reference for domains.cfg Signed-off-by: Lukas Wagner <l.wagner@proxmox.com> 2023-02-09 14:31:21 +01:00
			`File Format`
			`^^^^^^^^^^^`

			`.. include:: config/domains/format.rst`


			`Options`
			`^^^^^^^`

			`.. include:: config/domains/config.rst`

docs: add user.cfg.5 manual page 2021-02-10 16:37:27 +01:00
docs: move tape config/syntax to appendix 2021-04-14 14:14:30 +02:00			``media-pool.cfg``
			`~~~~~~~~~~~~~~~~~~`

			`File Format`
			`^^^^^^^^^^^`

			`.. include:: config/media-pool/format.rst`


			`Options`
			`^^^^^^^`

			`.. include:: config/media-pool/config.rst`

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> 2024-10-10 15:26:41 +02:00			``node.cfg``
			`~~~~~~~~~~~~~~~~~~`

			`Options`
			`^^^^^^^`

			`.. include:: config/node/format.rst`

docs: add documentation for notification system Mostly copied from PVE and adapted where it makes sense. Signed-off-by: Lukas Wagner <l.wagner@proxmox.com> Tested-by: Maximiliano Sandoval <m.sandoval@proxmox.com> Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com> 2024-04-23 13:52:27 +02:00			`.. _notifications.cfg:`

			``notifications.cfg``
			`~~~~~~~~~~~~~~~~~~~~~`

			`File Format`
			`^^^^^^^^^^^`

			`.. include:: config/notifications/format.rst`


			`Options`
			`^^^^^^^`

			`.. include:: config/notifications/config.rst`

docs: notifications: rewrite overview for more clarity Also link to the following subsections where applicable. Signed-off-by: Lukas Wagner <l.wagner@proxmox.com> 2024-04-26 13:23:34 +02:00			`.. _notifications_priv.cfg:`

docs: add documentation for notification system Mostly copied from PVE and adapted where it makes sense. Signed-off-by: Lukas Wagner <l.wagner@proxmox.com> Tested-by: Maximiliano Sandoval <m.sandoval@proxmox.com> Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com> 2024-04-23 13:52:27 +02:00			``notifications-priv.cfg``
			`~~~~~~~~~~~~~~~~~~~~~~~~~~`

			`File Format`
			`^^^^^^^^^^^`

			`.. include:: config/notifications-priv/format.rst`


			`Options`
			`^^^^^^^`

			`.. include:: config/notifications-priv/config.rst`

docs: move tape config/syntax to appendix 2021-04-14 14:14:30 +02:00
			``tape.cfg``
			`~~~~~~~~~~~~`

			`File Format`
			`^^^^^^^^^^^`

			`.. include:: config/tape/format.rst`


			`Options`
			`^^^^^^^`

			`.. include:: config/tape/config.rst`


			``tape-job.cfg``
			`~~~~~~~~~~~~~~~~`

			`File Format`
			`^^^^^^^^^^^`

			`.. include:: config/tape-job/format.rst`


			`Options`
			`^^^^^^^`

			`.. include:: config/tape-job/config.rst`


docs: add user.cfg.5 manual page 2021-02-10 16:37:27 +01:00			``user.cfg``
docs: move tape config/syntax to appendix 2021-04-14 14:14:30 +02:00			`~~~~~~~~~~~~`
docs: add user.cfg.5 manual page 2021-02-10 16:37:27 +01:00
			`File Format`
			`^^^^^^^^^^^`

			`.. include:: config/user/format.rst`


			`Options`
			`^^^^^^^`

			`.. include:: config/user/config.rst`
docs: add manukal page for remote.cfg 2021-02-11 11:25:15 +01:00

			``remote.cfg``
			`~~~~~~~~~~~~~~~~~`

			`File Format`
			`^^^^^^^^^^^`

			`.. include:: config/remote/format.rst`


			`Options`
			`^^^^^^^`

			`.. include:: config/remote/config.rst`
docs: add manual page fro sysc.cfg 2021-02-11 11:52:37 +01:00

			``sync.cfg``
			`~~~~~~~~~~~~~~~~~`

			`File Format`
			`^^^^^^^^^^^`

			`.. include:: config/sync/format.rst`


			`Options`
			`^^^^^^^`

			`.. include:: config/sync/config.rst`
docs: add manual page for verification.cfg 2021-02-11 13:40:11 +01:00

			``verification.cfg``
docs: add services.rst to section sysadmin 2021-02-13 09:34:32 +01:00			`~~~~~~~~~~~~~~~~~~~~`
docs: add manual page for verification.cfg 2021-02-11 13:40:11 +01:00
			`File Format`
			`^^^^^^^^^^^`

			`.. include:: config/verification/format.rst`


			`Options`
			`^^^^^^^`

			`.. include:: config/verification/config.rst`