From 1c273b33125ede89a54c973d7d84f48384f7a166 Mon Sep 17 00:00:00 2001 From: tschettervictor <85497460+tschettervictor@users.noreply.github.com> Date: Sat, 31 May 2025 19:57:32 -0600 Subject: [PATCH] docs: Document built in ARGS for template --- docs/chapters/template.rst | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/chapters/template.rst b/docs/chapters/template.rst index 80190e88..edd9b5f5 100644 --- a/docs/chapters/template.rst +++ b/docs/chapters/template.rst @@ -86,6 +86,10 @@ If the above template is called with ``--arg JAIL=myjail --arg IP=10.3.3.3``, th be passed along to ``other/template`` as well, with the matching variable. So ``${JAIL}`` will be ``myjail`` and ``${IP}`` will be ``10.3.3.3``. +The ARG hook has three values that are built in, and will differ for every jail. The values +are ``JAIL_NAME``, ``JAIL_IP``, and ``JAIL_IP6``. These can be used inside any template without +setting the values at the top of the Bastillefile. The values are automatically retrieved from +the targeted jails configuration. ``CMD`` - run the specified command