aboutsummaryrefslogtreecommitdiffstats
path: root/doc/source/system/bundles
diff options
context:
space:
mode:
Diffstat (limited to 'doc/source/system/bundles')
-rw-r--r--doc/source/system/bundles/default.html37
-rw-r--r--doc/source/system/bundles/firewall.html29
-rw-r--r--doc/source/system/bundles/mount.html48
-rw-r--r--doc/source/system/bundles/networking.html35
-rw-r--r--doc/source/system/bundles/seat-manager.html31
-rw-r--r--doc/source/system/bundles/system-bus.html34
-rw-r--r--doc/source/system/bundles/udev.html36
7 files changed, 250 insertions, 0 deletions
diff --git a/doc/source/system/bundles/default.html b/doc/source/system/bundles/default.html
new file mode 100644
index 0000000..80b58c0
--- /dev/null
+++ b/doc/source/system/bundles/default.html
@@ -0,0 +1,37 @@
+<!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>default system bundle</title>
+ <meta name="Description" content="System bundle that is by default started during boot." />
+ <meta name="Keywords" content="goetia s6-rc bundle system supervision tree" />
+ </head>
+ <header>
+ <p>
+ <a href="//0x53.net/software/goetia/goetia-base">goetia-base</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 default system bundle</h1>
+ <p>
+ This bundle is started on boot and everything that is
+ desired to be autostarted should be part of it.
+ Minimize the amount of services in this bundle.
+ <a href="https://skarnet.org/software/s6-rc">s6-rc</a>
+ will automatically start (and stop) all dependencies.
+ Add only what should be unconditionally there.
+ An example of this would be a service to mount a storage device
+ containing photos. No other service will probably depend on
+ this, since none needs the photos, but the user still needs
+ this to be mounted.
+ </p>
+ </body>
+</html>
diff --git a/doc/source/system/bundles/firewall.html b/doc/source/system/bundles/firewall.html
new file mode 100644
index 0000000..ecfe00e
--- /dev/null
+++ b/doc/source/system/bundles/firewall.html
@@ -0,0 +1,29 @@
+<!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>firewall system bundle</title>
+ <meta name="Description" content="System bundle depended upon by services that should be started after the firewall is configured." />
+ <meta name="Keywords" content="goetia s6-rc bundle system supervision tree" />
+ </head>
+ <header>
+ <p>
+ <a href="//0x53.net/software/goetia/goetia-base">goetia-base</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 firewall system bundle</h1>
+ <p>
+ Some services might require a frirewall to be ready
+ when started, those shall depend on this bundle.
+ </p>
+ </body>
+</html>
diff --git a/doc/source/system/bundles/mount.html b/doc/source/system/bundles/mount.html
new file mode 100644
index 0000000..c295d49
--- /dev/null
+++ b/doc/source/system/bundles/mount.html
@@ -0,0 +1,48 @@
+<!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 system bundle</title>
+ <meta name="Description" content="System bundle that is by default depended upon by program that need to read/write from/to disk." />
+ <meta name="Keywords" content="goetia s6-rc bundle system supervision tree" />
+ </head>
+ <header>
+ <p>
+ <a href="//0x53.net/software/goetia/goetia-base">goetia-base</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 system bundle</h1>
+ <p>
+ This bundle is by default a declared dependency of many
+ services provided by goetia.
+ Most importantly, it is a dependency of all autogenerated
+ loggers.
+ It should thus contain the mount services for all drives
+ that are used for
+ <a href="//0x53.net/software/goetia/logdir.html">logging</a>.
+ </p>
+ <p>
+ In most cases, the <code>remount-root</code>
+ <a href="https://skarnet.org/software/s6-rc/s6-rc-compile.html#source">source directory</a>
+ should be added to this bundle.
+ This source directory is part of the kernel specific packages,
+ like
+ <a href="//0x53.net/software/goetia/goetia-linux/">goetia-linux</a>.
+ </p>
+ <h2>See also</h2>
+ <ul>
+ <li>
+ <a href="//0x53.net/software/goetia/tutorials/base/mount.html">Mount tutorial</a>
+ </li>
+ </ul>
+ </body>
+</html>
diff --git a/doc/source/system/bundles/networking.html b/doc/source/system/bundles/networking.html
new file mode 100644
index 0000000..0e3e18b
--- /dev/null
+++ b/doc/source/system/bundles/networking.html
@@ -0,0 +1,35 @@
+<!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>networking system bundle</title>
+ <meta name="Description" content="System bundle that is depended upon by services requiring the correct network configuration to be applied." />
+ <meta name="Keywords" content="goetia s6-rc bundle system supervision tree" />
+ </head>
+ <header>
+ <p>
+ <a href="//0x53.net/software/goetia/goetia-base">goetia-base</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 networking system bundle</h1>
+ <p>
+ Services requiring networking to be set up
+ will depend on this.
+ </p>
+ <h2>See also</h2>
+ <ul>
+ <li>
+ <a href="//0x53.net/software/goetia/tutorials/base/networking.html">Networking tutorial</a>
+ </li>
+ </ul>
+ </body>
+</html>
diff --git a/doc/source/system/bundles/seat-manager.html b/doc/source/system/bundles/seat-manager.html
new file mode 100644
index 0000000..eab3d26
--- /dev/null
+++ b/doc/source/system/bundles/seat-manager.html
@@ -0,0 +1,31 @@
+<!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>seat-manager system bundle</title>
+ <meta name="Description" content="System bundle that is depended upon by services requiring a seat manager to be running." />
+ <meta name="Keywords" content="goetia s6-rc bundle system supervision tree" />
+ </head>
+ <header>
+ <p>
+ <a href="//0x53.net/software/goetia/goetia-base">goetia-base</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 seat-manager system bundle</h1>
+ <p>
+ Refer to the
+ <a href="//0x53.net/software/goetia/tutorials/ui/seatsession.html">seat and session management</a>
+ tutorial, to understand the purpose of seat managers.
+ This bundle abstracts over the choices one has here.
+ </p>
+ </body>
+</html>
diff --git a/doc/source/system/bundles/system-bus.html b/doc/source/system/bundles/system-bus.html
new file mode 100644
index 0000000..4efd015
--- /dev/null
+++ b/doc/source/system/bundles/system-bus.html
@@ -0,0 +1,34 @@
+<!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>system-bus system bundle</title>
+ <meta name="Description" content="System bundle depended upon by services requiring a system bus to be up." />
+ <meta name="Keywords" content="goetia s6-rc bundle bus system-bus dbus system supervision tree" />
+ </head>
+ <header>
+ <p>
+ <a href="//0x53.net/software/goetia/goetia-base">goetia-base</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 system-bus system bundle</h1>
+ <p>
+ Some software requires a system-bus
+ implementing - usually the dbus interface.
+ The only currently available implementation
+ of this interface is
+ <a href="https://www.freedesktop.org/wiki/Software/dbus/">dbus-daemon</a>.
+ The source directory is part of
+ <a href="//0x53.net/software/goetia/goetia-base">goetia-base</a>.
+ </p>
+ </body>
+</html>
diff --git a/doc/source/system/bundles/udev.html b/doc/source/system/bundles/udev.html
new file mode 100644
index 0000000..835f04b
--- /dev/null
+++ b/doc/source/system/bundles/udev.html
@@ -0,0 +1,36 @@
+<!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>udev system bundle</title>
+ <meta name="Description" content="System bundle that is depended upon by services requiring the userspace device manager to be up." />
+ <meta name="Keywords" content="goetia s6-rc bundle system supervision tree" />
+ </head>
+ <header>
+ <p>
+ <a href="//0x53.net/software/goetia/goetia-base">goetia-base</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 udev system bundle</h1>
+ <p>
+ Some software depends on userspace device management software
+ to setup device permissions, symlinks and more.
+ The corresponding services will depend on this bundle.
+ </p>
+ <h2>See also</h2>
+ <ul>
+ <li>
+ <a href="//0x53.net/software/goetia/tutorials/base/udev.html">Udev tutorial</a>
+ </li>
+ </ul>
+ </body>
+</html>