summaryrefslogtreecommitdiffstats
path: root/doc/server/plugins/misc/acl.txt
diff options
context:
space:
mode:
Diffstat (limited to 'doc/server/plugins/misc/acl.txt')
-rw-r--r--doc/server/plugins/misc/acl.txt35
1 files changed, 34 insertions, 1 deletions
diff --git a/doc/server/plugins/misc/acl.txt b/doc/server/plugins/misc/acl.txt
index 73f99bf85..226b56a44 100644
--- a/doc/server/plugins/misc/acl.txt
+++ b/doc/server/plugins/misc/acl.txt
@@ -189,7 +189,7 @@ The ACL descriptions allow you to use '*' as a wildcard for any number
of characters *other than* ``.``. That is:
* ``*`` would match ``DeclareVersion`` and ``GetProbes``, but would
- *not* match ``Git.Update`.
+ *not* match ``Git.Update``.
* ``*.*`` would match ``Git.Update``, but not ``DeclareVersion`` or
``GetProbes``.
@@ -200,3 +200,36 @@ could also do something like ``*.toggle_debug`` to allow a host to
enable or disable debugging for all plugins.
No other bash globbing is supported.
+
+Examples
+========
+
+The :ref:`default ACL list <server-access-control>` can be described
+in ``ip.xml`` fairly simply:
+
+.. code-block:: xml
+
+ <ACL>
+ <Allow address="127.0.0.1" method="*.*"/>
+ <Allow address="127.0.0.1" method="*"/>
+ <Deny method="*.*"/>
+ <Deny method="*_debug"/>
+ <Deny method="get_statistics"/>
+ <Allow method="*"/>
+ </ACL>
+
+A basic configuration that is still very secure but perhaps more
+functional could be given in ``metadata.xml``:
+
+.. code-block:: xml
+
+ <ACL>
+ <Group name="bcfg2-server">
+ <Allow method="*.*"/>
+ <Allow method="*"/>
+ </Group>
+ <Deny method="*.*"/>
+ <Deny method="*_debug"/>
+ <Deny method="get_statistics"/>
+ <Allow method="*"/>
+ </ACL>