From f38dc4b0a1027469e0c5abd9b70573ee070d603f Mon Sep 17 00:00:00 2001 From: Moritz Poldrack Date: Sun, 6 Jul 2025 19:41:22 +0200 Subject: [PATCH] docs: add section for example configurations Since ACLs may be at times a bit intransparent to a user, an example section seems like a worthwhile addition. Signed-off-by: Moritz Poldrack --- docs/ref/acls.md | 26 ++++++++++++++++++++++++++ mkdocs.yml | 2 ++ 2 files changed, 28 insertions(+) diff --git a/docs/ref/acls.md b/docs/ref/acls.md index 63f83ae2..5f886dc1 100644 --- a/docs/ref/acls.md +++ b/docs/ref/acls.md @@ -187,3 +187,29 @@ Here are the ACL's to implement the same permissions as above: ] } ``` + +## Examples + +The following are examples of ready-to-use or -adapt snippets to use in your configuration. + +/// details | Full mesh + +This snippet allows all devices to access all other devices. It is the noop ACL. + +```json +{ + "acls": [ + { + "action": "accept", + "src": [ + "*" + ], + "dst": [ + "*:*" + ] + } + ] +} +``` + +/// diff --git a/mkdocs.yml b/mkdocs.yml index b096aed8..2009eb74 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -35,6 +35,7 @@ theme: # - navigation.tabs.sticky - navigation.top - navigation.tracking + - pymdownx.blocks.details - search.highlight - search.share - search.suggest @@ -120,6 +121,7 @@ markdown_extensions: generic: true - pymdownx.betterem: smart_enable: all + - pymdownx.blocks.details - pymdownx.caret - pymdownx.details - pymdownx.emoji: