Skip to content

Commit

Permalink
docs: (Sphinx) renamed autogenerated files from rst to rst.inc
Browse files Browse the repository at this point in the history
These files have been created from the *-config-schema.json files (from 18.2.6)
by the generate-resoure-descriptions.py script.
As they are to be included in Sphinx,
the new extension is now "*.rst.inc".
  • Loading branch information
joergsteffens committed Mar 5, 2019
1 parent 56e54b9 commit ed3bf00
Show file tree
Hide file tree
Showing 37 changed files with 1,135 additions and 748 deletions.
@@ -1,6 +1,3 @@
Catalog
-------

.. config:option:: dir/catalog/Address

:type: STRING
Expand Down
@@ -1,6 +1,3 @@
Client
------

.. config:option:: dir/client/Address

:required: True
Expand Down Expand Up @@ -41,7 +38,7 @@ Client

.. config:option:: dir/client/Catalog

:type: CommonResourceHeader
:type: RES

.. include:: /config-directive-description/dir-client-Catalog.rst.inc

Expand Down Expand Up @@ -113,7 +110,7 @@ Client
.. config:option:: dir/client/FdPort

:type: PINT32
:default: 8102
:default: 9102

*This directive is an alias.*

Expand Down Expand Up @@ -247,7 +244,7 @@ Client
.. config:option:: dir/client/Port

:type: PINT32
:default: 8102
:default: 9102

.. include:: /config-directive-description/dir-client-Port.rst.inc

Expand Down Expand Up @@ -322,7 +319,7 @@ Client

.. config:option:: dir/client/TlsCaCertificateDir

:type: STDDIRECTORY
:type: DIRECTORY

Path of a TLS CA certificate directory.

Expand All @@ -332,7 +329,7 @@ Client

.. config:option:: dir/client/TlsCaCertificateFile

:type: STDDIRECTORY
:type: DIRECTORY

Path of a PEM encoded TLS CA certificate(s) file.

Expand All @@ -342,7 +339,7 @@ Client

.. config:option:: dir/client/TlsCertificate

:type: STDDIRECTORY
:type: DIRECTORY

Path of a PEM encoded TLS certificate.

Expand All @@ -352,7 +349,7 @@ Client

.. config:option:: dir/client/TlsCertificateRevocationList

:type: STDDIRECTORY
:type: DIRECTORY

Path of a Certificate Revocation List file.

Expand All @@ -362,7 +359,7 @@ Client

.. config:option:: dir/client/TlsCipherList

:type: STRING
:type: DIRECTORY

List of valid TLS Ciphers.

Expand All @@ -372,7 +369,7 @@ Client

.. config:option:: dir/client/TlsDhFile

:type: STDDIRECTORY
:type: DIRECTORY

Path to PEM encoded Diffie-Hellman parameter file. If this directive is specified, DH key exchange will be used for the ephemeral keying, allowing for forward secrecy of communications.

Expand All @@ -383,7 +380,7 @@ Client
.. config:option:: dir/client/TlsEnable

:type: BOOLEAN
:default: no
:default: yes

Enable TLS support.

Expand All @@ -393,36 +390,14 @@ Client

.. config:option:: dir/client/TlsKey

:type: STDDIRECTORY
:type: DIRECTORY

Path of a PEM encoded private key. It must correspond to the specified "TLS Certificate".

.. include:: /config-directive-description/dir-client-TlsKey.rst.inc



.. config:option:: dir/client/TlsPskEnable
:type: BOOLEAN
:default: yes

Enable TLS-PSK support.

.. include:: /config-directive-description/dir-client-TlsPskEnable.rst.inc



.. config:option:: dir/client/TlsPskRequire
:type: BOOLEAN
:default: no

Without setting this to yes, Bareos can fall back to use unencryption connections. Enabling this implicitly sets "TLS-PSK Enable = yes".

.. include:: /config-directive-description/dir-client-TlsPskRequire.rst.inc



.. config:option:: dir/client/TlsRequire

:type: BOOLEAN
Expand Down
@@ -1,6 +1,3 @@
Console
-------

.. config:option:: dir/console/CatalogACL

:type: ACL
Expand Down Expand Up @@ -141,7 +138,7 @@ Console

.. config:option:: dir/console/TlsCaCertificateDir

:type: STDDIRECTORY
:type: DIRECTORY

Path of a TLS CA certificate directory.

Expand All @@ -151,7 +148,7 @@ Console

.. config:option:: dir/console/TlsCaCertificateFile

:type: STDDIRECTORY
:type: DIRECTORY

Path of a PEM encoded TLS CA certificate(s) file.

Expand All @@ -161,7 +158,7 @@ Console

.. config:option:: dir/console/TlsCertificate

:type: STDDIRECTORY
:type: DIRECTORY

Path of a PEM encoded TLS certificate.

Expand All @@ -171,7 +168,7 @@ Console

.. config:option:: dir/console/TlsCertificateRevocationList

:type: STDDIRECTORY
:type: DIRECTORY

Path of a Certificate Revocation List file.

Expand All @@ -181,7 +178,7 @@ Console

.. config:option:: dir/console/TlsCipherList

:type: STRING
:type: DIRECTORY

List of valid TLS Ciphers.

Expand All @@ -191,7 +188,7 @@ Console

.. config:option:: dir/console/TlsDhFile

:type: STDDIRECTORY
:type: DIRECTORY

Path to PEM encoded Diffie-Hellman parameter file. If this directive is specified, DH key exchange will be used for the ephemeral keying, allowing for forward secrecy of communications.

Expand All @@ -202,7 +199,7 @@ Console
.. config:option:: dir/console/TlsEnable

:type: BOOLEAN
:default: no
:default: yes

Enable TLS support.

Expand All @@ -212,55 +209,43 @@ Console

.. config:option:: dir/console/TlsKey

:type: STDDIRECTORY
:type: DIRECTORY

Path of a PEM encoded private key. It must correspond to the specified "TLS Certificate".

.. include:: /config-directive-description/dir-console-TlsKey.rst.inc



.. config:option:: dir/console/TlsPskEnable
:type: BOOLEAN
:default: yes

Enable TLS-PSK support.

.. include:: /config-directive-description/dir-console-TlsPskEnable.rst.inc



.. config:option:: dir/console/TlsPskRequire
.. config:option:: dir/console/TlsRequire

:type: BOOLEAN
:default: no

Without setting this to yes, Bareos can fall back to use unencryption connections. Enabling this implicitly sets "TLS-PSK Enable = yes".
Without setting this to yes, Bareos can fall back to use unencrypted connections. Enabling this implicitly sets "TLS Enable = yes".

.. include:: /config-directive-description/dir-console-TlsPskRequire.rst.inc
.. include:: /config-directive-description/dir-console-TlsRequire.rst.inc



.. config:option:: dir/console/TlsRequire
.. config:option:: dir/console/TlsVerifyPeer

:type: BOOLEAN
:default: no

Without setting this to yes, Bareos can fall back to use unencrypted connections. Enabling this implicitly sets "TLS Enable = yes".
If disabled, all certificates signed by a known CA will be accepted. If enabled, the CN of a certificate must the Address or in the "TLS Allowed CN" list.

.. include:: /config-directive-description/dir-console-TlsRequire.rst.inc
.. include:: /config-directive-description/dir-console-TlsVerifyPeer.rst.inc



.. config:option:: dir/console/TlsVerifyPeer
.. config:option:: dir/console/UsePamAuthentication

:type: BOOLEAN
:default: no
:version: 18.2.4

If disabled, all certificates signed by a known CA will be accepted. If enabled, the CN of a certificate must the Address or in the "TLS Allowed CN" list.

.. include:: /config-directive-description/dir-console-TlsVerifyPeer.rst.inc
.. include:: /config-directive-description/dir-console-UsePamAuthentication.rst.inc



Expand Down
@@ -1,9 +1,6 @@
Counter
-------

.. config:option:: dir/counter/Catalog

:type: CommonResourceHeader
:type: RES

.. include:: /config-directive-description/dir-counter-Catalog.rst.inc

Expand Down Expand Up @@ -48,7 +45,7 @@ Counter

.. config:option:: dir/counter/WrapCounter

:type: CommonResourceHeader
:type: RES

.. include:: /config-directive-description/dir-counter-WrapCounter.rst.inc

Expand Down

This file was deleted.

Empty file.

0 comments on commit ed3bf00

Please sign in to comment.