summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorSol Jerome <sol.jerome@gmail.com>2016-07-15 07:31:34 -0500
committerSol Jerome <sol.jerome@gmail.com>2016-07-15 07:31:34 -0500
commit6882df7d2f38cae19a0b68ac0278a8899ca4d3f5 (patch)
treea187b8f525c94b99bee75d59691a5b6a38d6d997 /doc
parent7d70399d72c9274d1ea2eef285bb1c7d389b681b (diff)
parent2e3ae1a41f6333a075542ce7f411b1753caef684 (diff)
downloadbcfg2-6882df7d2f38cae19a0b68ac0278a8899ca4d3f5.tar.gz
bcfg2-6882df7d2f38cae19a0b68ac0278a8899ca4d3f5.tar.bz2
bcfg2-6882df7d2f38cae19a0b68ac0278a8899ca4d3f5.zip
Merge branch 'fix/docs' of https://github.com/AlexanderS/bcfg2
Diffstat (limited to 'doc')
-rw-r--r--doc/server/encryption.txt9
-rw-r--r--doc/server/plugins/connectors/grouplogic.txt4
-rw-r--r--doc/server/plugins/generators/cfg.txt2
-rw-r--r--doc/server/plugins/grouping/ldap.txt2
4 files changed, 9 insertions, 8 deletions
diff --git a/doc/server/encryption.txt b/doc/server/encryption.txt
index db5e2ae29..c186bc31d 100644
--- a/doc/server/encryption.txt
+++ b/doc/server/encryption.txt
@@ -225,16 +225,17 @@ be able to decrypt everything.) In this case, you want to enable lax
decryption in the ``[encryption]`` section of ``bcfg2.conf``::
[encryption]
- decrypt = lax
+ lax_decryption = true
This causes a failed decrypt to produce a warning only, not an error.
This can be overridden by individual XML files by setting
-``decrypt="strict"`` on the top-level tag (or, vice-versa; if strict
-is the default an XML file can specify ``decrypt="lax"``.
+``lax_decryption="false"`` on the top-level tag (or, vice-versa; if
+strict is the default an XML file can specify
+``lax_decryption="true"``.
Note that you could, for instance, set lax decryption by default, and
-then set strict decryption on individual files.
+then disable it on individual files.
Encryption API
==============
diff --git a/doc/server/plugins/connectors/grouplogic.txt b/doc/server/plugins/connectors/grouplogic.txt
index abf425202..dc59e4e0e 100644
--- a/doc/server/plugins/connectors/grouplogic.txt
+++ b/doc/server/plugins/connectors/grouplogic.txt
@@ -92,9 +92,9 @@ generate the tedious config:
.. code-block:: xml
<GroupLogic xmlns:py="http://genshi.edgewall.org/">
- <py:for each="component in metadata.query.all_groups_in_category("webapp-component")>
+ <py:for each="component in metadata.query.all_groups_in_category('webapp-component')">
<Group name="${component}">
- <py:for each="env in metadata.query.all_groups_in_category("environment")>
+ <py:for each="env in metadata.query.all_groups_in_category('environment')">
<Group name="${env}">
<Group name="${component}-${env}"/>
</Group>
diff --git a/doc/server/plugins/generators/cfg.txt b/doc/server/plugins/generators/cfg.txt
index 7e7a7c72e..026c33ba2 100644
--- a/doc/server/plugins/generators/cfg.txt
+++ b/doc/server/plugins/generators/cfg.txt
@@ -488,7 +488,7 @@ complex:
.. code-block:: xml
- <PrivateKey category="environment"/>
+ <PrivateKey category="environment">
<Params bits="1024" type="dsa"/>
<Group name="secure">
<Passphrase encrypted="secure">U2FsdGVkX19xACol83uyPELP94s4CmngD12oU6PLLuE=</Passphrase>
diff --git a/doc/server/plugins/grouping/ldap.txt b/doc/server/plugins/grouping/ldap.txt
index 96e224761..af18680d2 100644
--- a/doc/server/plugins/grouping/ldap.txt
+++ b/doc/server/plugins/grouping/ldap.txt
@@ -196,7 +196,7 @@ LdapQuery
.. method:: LdapQuery.get_result(self, metadata, \**kwargs)
- This executes the query. First it will call ``prepare_query() for you, then it will try
+ This executes the query. First it will call ``prepare_query()`` for you, then it will try
to execute the query with the specified connection and last it will call ``process_result()``
and return that return value.