From 5e95d487982b9362b544139b98d1da55fa6ef78c Mon Sep 17 00:00:00 2001 From: PS Date: Sat, 7 Feb 2026 10:20:30 +0100 Subject: Add doc --- doc/source/system/bundles/default.html | 37 ++++++++++++++++++++++ doc/source/system/bundles/firewall.html | 29 +++++++++++++++++ doc/source/system/bundles/mount.html | 48 +++++++++++++++++++++++++++++ doc/source/system/bundles/networking.html | 35 +++++++++++++++++++++ doc/source/system/bundles/seat-manager.html | 31 +++++++++++++++++++ doc/source/system/bundles/system-bus.html | 34 ++++++++++++++++++++ doc/source/system/bundles/udev.html | 36 ++++++++++++++++++++++ 7 files changed, 250 insertions(+) create mode 100644 doc/source/system/bundles/default.html create mode 100644 doc/source/system/bundles/firewall.html create mode 100644 doc/source/system/bundles/mount.html create mode 100644 doc/source/system/bundles/networking.html create mode 100644 doc/source/system/bundles/seat-manager.html create mode 100644 doc/source/system/bundles/system-bus.html create mode 100644 doc/source/system/bundles/udev.html (limited to 'doc/source/system/bundles') 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 @@ + + + + + + + default system bundle + + + +
+

+ goetia-base +
+ goetia +
+ Software +
+ 0x53.net +

+
+ +

The default system bundle

+

+ 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. + s6-rc + 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. +

+ + 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 @@ + + + + + + + firewall system bundle + + + +
+

+ goetia-base +
+ goetia +
+ Software +
+ 0x53.net +

+
+ +

The firewall system bundle

+

+ Some services might require a frirewall to be ready + when started, those shall depend on this bundle. +

+ + 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 @@ + + + + + + + mount system bundle + + + +
+

+ goetia-base +
+ goetia +
+ Software +
+ 0x53.net +

+
+ +

The mount system bundle

+

+ 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 + logging. +

+

+ In most cases, the remount-root + source directory + should be added to this bundle. + This source directory is part of the kernel specific packages, + like + goetia-linux. +

+

See also

+ + + 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 @@ + + + + + + + networking system bundle + + + +
+

+ goetia-base +
+ goetia +
+ Software +
+ 0x53.net +

+
+ +

The networking system bundle

+

+ Services requiring networking to be set up + will depend on this. +

+

See also

+ + + 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 @@ + + + + + + + seat-manager system bundle + + + +
+

+ goetia-base +
+ goetia +
+ Software +
+ 0x53.net +

+
+ +

The seat-manager system bundle

+

+ Refer to the + seat and session management + tutorial, to understand the purpose of seat managers. + This bundle abstracts over the choices one has here. +

+ + 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 @@ + + + + + + + system-bus system bundle + + + +
+

+ goetia-base +
+ goetia +
+ Software +
+ 0x53.net +

+
+ +

The system-bus system bundle

+

+ Some software requires a system-bus + implementing - usually the dbus interface. + The only currently available implementation + of this interface is + dbus-daemon. + The source directory is part of + goetia-base. +

+ + 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 @@ + + + + + + + udev system bundle + + + +
+

+ goetia-base +
+ goetia +
+ Software +
+ 0x53.net +

+
+ +

The udev system bundle

+

+ Some software depends on userspace device management software + to setup device permissions, symlinks and more. + The corresponding services will depend on this bundle. +

+

See also

+ + + -- cgit v1.2.3