tyler/proxmox-backup
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

docs: add "Configuration Files" appendix

Browse Source
This commit is contained in:
Dietmar Maurer 2021-02-10 11:28:56 +01:00
parent 4a0d3a3e3f
commit b9a09a9501
4 changed files with 37 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
docs/config/datastore/format.rst Normal file
View File

@ -0,0 +1,15 @@
The file contains a list of datastore configuration sections. Each
section starts with a header ``datastore: <name>``, followed by the
datastore configuration options.
::
datastore: <name1>
path <path1>
<option1> <value1>
...
datastore: <name2>
path <path2>
...

15
docs/config/datastore/man5.rst
View File

@ -21,22 +21,9 @@ Backup Server. It contains the Datastore configuration.
File Format
===========
The file contains a list of datastore configuration sections. Each
section starts with a header ``datastore: <name>``, followed by the
datastore configuration options.
.. include:: format.rst
::
datastore: <name1>
path <path1>
<option1> <value1>
...
datastore: <name2>
path <path2>
...
Options
=======

20
docs/configuration-files.rst Normal file
View File

@ -0,0 +1,20 @@
Configuration Files
===================
All Proxmox Backup Server configuration files resides inside directory
``/etc/proxmox-backup/``.
``datastore.cfg``
~~~~~~~~~~~~~~~~~
File Format
^^^^^^^^^^^
.. include:: config/datastore/format.rst
Options
^^^^^^^
.. include:: config/datastore/config.rst

1
docs/index.rst
View File

@ -45,6 +45,7 @@ in the section entitled "GNU Free Documentation License".
:caption: Appendix
command-syntax.rst
configuration-files.rst
file-formats.rst
backup-protocol.rst
calendarevents.rst