From 46c01f8ec47c611cac5a0158ead7d694127825a6 Mon Sep 17 00:00:00 2001 From: tschettervictor <85497460+tschettervictor@users.noreply.github.com> Date: Wed, 2 Apr 2025 23:52:33 -0600 Subject: [PATCH] docs: document LINE_IN_FILE --- docs/chapters/template.rst | 66 ++++++++++++++++++++------------------ 1 file changed, 35 insertions(+), 31 deletions(-) diff --git a/docs/chapters/template.rst b/docs/chapters/template.rst index a2a317cf..47803b72 100644 --- a/docs/chapters/template.rst +++ b/docs/chapters/template.rst @@ -22,37 +22,39 @@ template hook commands. Template Automation Hooks ------------------------- -+-------------+---------------------+-----------------------------------------+ -| HOOK | format | example | -+=============+=====================+=========================================+ -| ARG | ARG=VALUE | MINECRAFT_MEMX="1024M" | -+-------------+---------------------+-----------------------------------------+ -| CMD | /bin/sh command | /usr/bin/chsh -s /usr/local/bin/zsh | -+-------------+---------------------+-----------------------------------------+ -| CONFIG | set property value | set allow.mlock 1 | -+-------------+---------------------+-----------------------------------------+ -| CP/OVERLAY | path(s) | etc root usr (one per line) | -+-------------+---------------------+-----------------------------------------+ -| INCLUDE | template path/URL | http?://TEMPLATE_URL or project/path | -+-------------+---------------------+-----------------------------------------+ -| LIMITS | resource value | memoryuse 1G | -+-------------+---------------------+-----------------------------------------+ -| MOUNT | fstab syntax | /host/path container/path nullfs ro 0 0 | -+-------------+---------------------+-----------------------------------------+ -| OVERLAY | path(s) | etc root usr (one per line) | -+-------------+---------------------+-----------------------------------------+ -| PKG | port/pkg name(s) | vim-console zsh git-lite tree htop | -+-------------+---------------------+-----------------------------------------+ -| RDR | tcp port port | tcp 2200 22 (hostport jailport) | -+-------------+---------------------+-----------------------------------------+ -| RENDER | /path/file.txt | /usr/local/etc/gitea/conf/app.ini | -+-------------+---------------------+-----------------------------------------+ -| RESTART | | (restart jail) | -+-------------+---------------------+-----------------------------------------+ -| SERVICE | service command | 'nginx start' OR 'postfix reload' | -+-------------+---------------------+-----------------------------------------+ -| SYSRC | sysrc command(s) | nginx_enable=YES | -+-------------+---------------------+-----------------------------------------+ ++---------------+---------------------+-----------------------------------------+ +| HOOK | format | example | ++===============+=====================+=========================================+ +| ARG | ARG=VALUE | MINECRAFT_MEMX="1024M" | ++---------------+---------------------+-----------------------------------------+ +| CMD | /bin/sh command | /usr/bin/chsh -s /usr/local/bin/zsh | ++---------------+---------------------+-----------------------------------------+ +| CONFIG | set property value | set allow.mlock 1 | ++---------------+---------------------+-----------------------------------------+ +| CP/OVERLAY | path(s) | etc root usr (one per line) | ++---------------+---------------------+-----------------------------------------+ +| INCLUDE | template path/URL | http?://TEMPLATE_URL or project/path | ++---------------+---------------------+-----------------------------------------+ +| LIMITS | resource value | memoryuse 1G | ++---------------+---------------------+-----------------------------------------+ +| LINE_IN_FILE | line file_path | word /usr/local/word/word.conf | ++---------------+---------------------+-----------------------------------------+ +| MOUNT | fstab syntax | /host/path container/path nullfs ro 0 0 | ++---------------+---------------------+-----------------------------------------+ +| OVERLAY | path(s) | etc root usr (one per line) | ++---------------+---------------------+-----------------------------------------+ +| PKG | port/pkg name(s) | vim-console zsh git-lite tree htop | ++---------------+---------------------+-----------------------------------------+ +| RDR | tcp port port | tcp 2200 22 (hostport jailport) | ++---------------+---------------------+-----------------------------------------+ +| RENDER | /path/file.txt | /usr/local/etc/gitea/conf/app.ini | ++---------------+---------------------+-----------------------------------------+ +| RESTART | | (restart jail) | ++---------------+---------------------+-----------------------------------------+ +| SERVICE | service command | 'nginx start' OR 'postfix reload' | ++---------------+---------------------+-----------------------------------------+ +| SYSRC | sysrc command(s) | nginx_enable=YES | ++---------------+---------------------+-----------------------------------------+ Template Hook Descriptions -------------------------- @@ -78,6 +80,8 @@ INCLUDE - specify a template to include. Make sure the template is bootstrap LIMITS - set the specified resource value for the jail +LIMITS - add specified word to specified file if not present + MOUNT - mount specified files/directories inside the jail PKG - install specified packages inside jail