diff options
Diffstat (limited to 'doc/source')
| -rw-r--r-- | doc/source/system/net/nftables.html | 41 | ||||
| -rw-r--r-- | doc/source/system/other/local.html | 69 | ||||
| -rw-r--r-- | doc/source/system/other/syslog.html | 39 | ||||
| -rw-r--r-- | doc/source/system/vfs/mount-binfmt_misc.html | 81 |
4 files changed, 230 insertions, 0 deletions
diff --git a/doc/source/system/net/nftables.html b/doc/source/system/net/nftables.html new file mode 100644 index 0000000..4bcd42b --- /dev/null +++ b/doc/source/system/net/nftables.html @@ -0,0 +1,41 @@ +<!DOCTYPE html> +<html> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> + <meta http-equiv="Content-Language" content="en" /> + <meta name="viewport" content="width=device-width, initial-scale=1.0" /> + <title>nftables service</title> + <meta name="Description" content="System oneshot to set the firewall up using nftables." /> + <meta name="Keywords" content="goetia s6-rc Linux net firewall system supervision tree" /> + </head> + <header> + <p> + <a href="//0x53.net/software/goetia/goetia-linux">goetia-linux</a> + <br /> + <a href="//0x53.net/software/goetia">goetia</a> + <br /> + <a href="//0x53.net/software">Software</a> + <br /> + <a href="//0x53.net">0x53.net</a> + </p> + </header> + <body> + <h1>The nftables service</h1> + <p> + nftables is a + <a href="https://skarnet.org/software/s6-rc/s6-rc-compile.html#source">oneshot service</a> + to use + <a href="https://wiki.nftables.org/wiki-nftables/index.php/Main_Page">nftables</a> + </p> + <ul> + <li> + It runs <code>nft -f /etc/nftables.rules</code> + when it is started. + </li> + <li> + It runs <code>nft flush ruleset</code> + when it is stopped. + </li> + </ul> + </body> +</html> diff --git a/doc/source/system/other/local.html b/doc/source/system/other/local.html new file mode 100644 index 0000000..aa943e2 --- /dev/null +++ b/doc/source/system/other/local.html @@ -0,0 +1,69 @@ +<!DOCTYPE html> +<html> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> + <meta http-equiv="Content-Language" content="en" /> + <meta name="viewport" content="width=device-width, initial-scale=1.0" /> + <title>local service</title> + <meta name="Description" content="System oneshot that executes scripts." /> + <meta name="Keywords" content="goetia s6-rc Linux script system supervision tree" /> + </head> + <header> + <p> + <a href="//0x53.net/software/goetia/goetia-linux">goetia-linux</a> + <br /> + <a href="//0x53.net/software/goetia">goetia</a> + <br /> + <a href="//0x53.net/software">Software</a> + <br /> + <a href="//0x53.net">0x53.net</a> + </p> + </header> + <body> + <h1>The local service</h1> + <p> + local is a + <a href="https://skarnet.org/software/s6-rc/s6-rc-compile.html#source">oneshot service</a>. + </p> + <ul> + <li> + It tries to execute all + files <code>/etc/local.d/*.up</code> + when it is started (typically during boot). + </li> + <li> + It tries to execute all files <code>/etc/local.d/*.down</code> + when it is stopped (typically during shutdown). + </li> + </ul> + <p> + The files are executed in random order + and in parallel. + </p> + <section id="examples"> + <h2>Examples</h2> + <p> + An executable file <code>/etc/local.d/echo.up</code> + with the content + <pre> +#!/bin/execlineb -P + +echo "example" + </pre> + would be executed and write "example" to the system log + upon starting the service local. + </p> + <p> + An executable file <code>/etc/local.d/echo.down</code> + with the content + <pre> +#!/bin/execlineb -P + +echo "example" + </pre> + would be executed and write "example" to the system log + upon stopping the service local. + </p> + </section> + </body> +</html> diff --git a/doc/source/system/other/syslog.html b/doc/source/system/other/syslog.html new file mode 100644 index 0000000..c09af1a --- /dev/null +++ b/doc/source/system/other/syslog.html @@ -0,0 +1,39 @@ +<!DOCTYPE html> +<html> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> + <meta http-equiv="Content-Language" content="en" /> + <meta name="viewport" content="width=device-width, initial-scale=1.0" /> + <title>syslog service</title> + <meta name="Description" content="System longrun to emulate syslog." /> + <meta name="Keywords" content="goetia s6-rc Linux syslog system supervision tree" /> + </head> + <header> + <p> + <a href="//0x53.net/software/goetia/goetia-linux">goetia-linux</a> + <br /> + <a href="//0x53.net/software/goetia">goetia</a> + <br /> + <a href="//0x53.net/software">Software</a> + <br /> + <a href="//0x53.net">0x53.net</a> + </p> + </header> + <body> + <h1>The syslog service</h1> + <p> + syslog is a + <a href="https://skarnet.org/software/s6-rc/s6-rc-compile.html#source">longrun service</a> + to support legacy applications + that only support logging through a syslog socket. + </p> + <p> + It runs an instance of + <a href="https://skarnet.org/software/s6/s6-socklog.html">s6-socklog</a> + with the socket set to <code>/dev/log</code>. + The logs are then processed by + <a href="https://skarnet.org/software/s6/s6-log.html">s6-log</a> + (see <a href="//0x53.net/software/goetia/logdir.html">logging directory</a>). + </p> + </body> +</html> diff --git a/doc/source/system/vfs/mount-binfmt_misc.html b/doc/source/system/vfs/mount-binfmt_misc.html new file mode 100644 index 0000000..09cadc8 --- /dev/null +++ b/doc/source/system/vfs/mount-binfmt_misc.html @@ -0,0 +1,81 @@ +<!DOCTYPE html> +<html> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> + <meta http-equiv="Content-Language" content="en" /> + <meta name="viewport" content="width=device-width, initial-scale=1.0" /> + <title>mount-binfmt_misc service</title> + <meta name="Description" content="System oneshot service to populate the binfmt_misc filesystem." /> + <meta name="Keywords" content="goetia s6-rc Linux bin system supervision tree" /> + </head> + <header> + <p> + <a href="//0x53.net/software/goetia/goetia-linux">goetia-linux</a> + <br /> + <a href="//0x53.net/software/goetia">goetia</a> + <br /> + <a href="//0x53.net/software">Software</a> + <br /> + <a href="//0x53.net">0x53.net</a> + </p> + </header> + <body> + <h1>The mount-binfmt_misc service</h1> + <p> + mount-binfmt_misc is a + <a href="https://skarnet.org/software/s6-rc/s6-rc-compile.html#source">oneshot service</a> + set up the + <a href="https://docs.kernel.org/admin-guide/binfmt-misc.html">binfmt_misc</a> + virtual filesystem. + </p> + <p> + When it is started: + </p> + <ul> + <li> + It mounts the binfmt_misc virtual filesystem at + <code>/proc/sys/fs/binfmt_misc</code>. + </li> + <li> + It reads all files at + <code>/etc/binfmt.d/*</code> + </li> + <li> + For each line in each file it finds there, + ignoring empty lines and lines starting with a + <code>#</code>, + it tries to apply the line + as a registration string as defined + <a href="https://docs.kernel.org/admin-guide/binfmt-misc.html">here</a> + under the following conditions: + </li> + <ul> + <li> + Files are ordered by + <a href="https://skarnet.org/software/execline/elglob.html">elglob</a>. + </li> + <li> + If <code>name</code> fields are duplicated, + the last one processed will be applied. + </li> + </ul> + </ul> + <p> + When it is stopped: + </p> + <ul> + <li> + It umounts <code>/proc/sys/fs/binfmt_misc</code>. + </li> + </ul> + <section id="examples"> + <h2>Examples</h2> + <p> + A file <code>/etc/binfmt.d/wine.conf</code> + with the content <code>:DOSWin:M::MZ::/bin/wine:</code> + would make windows binaries be executed + using wine automatically. + </p> + </section> + </body> +</html> |