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/admin/seatd.html | 42 ++++++++++++++++ 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 ++++++++++++++ doc/source/user/bundle/audio.html | 31 ++++++++++++ doc/source/user/bundle/compositor.html | 33 +++++++++++++ doc/source/user/bundle/default.html | 39 +++++++++++++++ doc/source/user/bundle/session-bus.html | 34 +++++++++++++ doc/source/user/other/dbus-daemon.html | 44 +++++++++++++++++ doc/source/user/xdg/xdg-runtime-dir.html | 75 +++++++++++++++++++++++++++++ 14 files changed, 548 insertions(+) create mode 100644 doc/source/system/admin/seatd.html 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 create mode 100644 doc/source/user/bundle/audio.html create mode 100644 doc/source/user/bundle/compositor.html create mode 100644 doc/source/user/bundle/default.html create mode 100644 doc/source/user/bundle/session-bus.html create mode 100644 doc/source/user/other/dbus-daemon.html create mode 100644 doc/source/user/xdg/xdg-runtime-dir.html (limited to 'doc/source') diff --git a/doc/source/system/admin/seatd.html b/doc/source/system/admin/seatd.html new file mode 100644 index 0000000..6303835 --- /dev/null +++ b/doc/source/system/admin/seatd.html @@ -0,0 +1,42 @@ + + + + + + + seatd + + + +

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

+ +

The seatd service

+ Seatd is a seat manager. + This means that it mediates access to + hardware like a GPU or input devices to the compositor. +

+ This service makes the socket have + seat group permissions. + Thus the group seat must exist + and users intending to run a compositor need to + be part of that group. +

+ The service does not change the socket location, + by default it usually resides at + /run/seatd.sock. +

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

The networking system bundle

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

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

The audio user bundle

+ This bundle abstracts over the different + autio daemon implementations, + so services requiring a running audion daemon + can depend on this. +

+ + diff --git a/doc/source/user/bundle/compositor.html b/doc/source/user/bundle/compositor.html new file mode 100644 index 0000000..9d10e89 --- /dev/null +++ b/doc/source/user/bundle/compositor.html @@ -0,0 +1,33 @@ + + + + + + + compositor user bundle + + + +

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

+ +

The compositor user bundle

+ This bundle shall contain the service corresponding to the + main compositing program, e.g. the + Wayland + compositor or + X11. + instance. +

+ + diff --git a/doc/source/user/bundle/default.html b/doc/source/user/bundle/default.html new file mode 100644 index 0000000..2192a15 --- /dev/null +++ b/doc/source/user/bundle/default.html @@ -0,0 +1,39 @@ + + + + + + + default user bundle + + + +

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

+ +

The default user bundle

+ This bundle is started when the + user supervision tree + is started 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 + starting a wallpaper daemon, no other service + will probably depend on this but the user + wants the wallpaper to be there. +

+ + diff --git a/doc/source/user/bundle/session-bus.html b/doc/source/user/bundle/session-bus.html new file mode 100644 index 0000000..8984b80 --- /dev/null +++ b/doc/source/user/bundle/session-bus.html @@ -0,0 +1,34 @@ + + + + + + + session-bus user bundle + + + +

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

+ +

The session-bus user bundle

+ Some software requires a session-bus + - usually implementing 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/user/other/dbus-daemon.html b/doc/source/user/other/dbus-daemon.html new file mode 100644 index 0000000..f5290c8 --- /dev/null +++ b/doc/source/user/other/dbus-daemon.html @@ -0,0 +1,44 @@ + + + + + + + dbus-daemon + + + +

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

+ +

The dbus-daemon service

+ This service starts a session + dbus-daemon. + It is important to set the environment variable + DBUS_SESSION_BUS_ADDRESS, + so other services depending on dbus-daemon can find it. +

+ The DBUS_SESSION_BUS_ADDRESS environment variable + should be set at + ${HOME}/@userconfdir@/@USERTREE@/env/DBUS_SESSION_BUS_ADDRESS, + by writing the address into this file + (see configuration directory). + It is recomended to set + ${HOME}/@userconfdir@/@USERTREE@/env/DBUS_SESSION_BUS_ADDRESS, + to + @tmpusdir@/@usrrundir@/@USER@/@USERTREE@/session-bus + (see runtime directory). +

+ + diff --git a/doc/source/user/xdg/xdg-runtime-dir.html b/doc/source/user/xdg/xdg-runtime-dir.html new file mode 100644 index 0000000..3b17d8b --- /dev/null +++ b/doc/source/user/xdg/xdg-runtime-dir.html @@ -0,0 +1,75 @@ + + + + + + + xdg-runtime-dir + + + +

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

+ +

The xdg-runtime-dir service

+ This service dynamically creates the directory + specified in the environment variable + XDG_RUNTIME_DIR. +

+ Starting this service creates the directory + and sets the proper permissions, + stopping it deletes it. +

+ It is recommended to set + XDG_RUNTIME_DIR + to the + @USER@/@USERTREE@/xdg-runtime-dir + subdirectory of the + user runtime directory. + This allows to follow the + XDG Base Directory Specification. +

+ If more than one + user supervision tree + per user is used to have multiple + sessions + with a distinct UI server, audio server, etc. + It makes sense for each session to have its own, + distinct xdg-runtime-dir, + since it is often used for sockets and temporary files + of said UI server, audio server, etc. + Setting + XDG_RUNTIME_DIR + as described above, allows for this. + Note, however, that this deviates from the + XDG Base Directory Specification. +

+ All user services writing to or reading from + XDG_RUNTIME_DIR + should depend on this service. +

The seatd service

The default system bundle

The firewall system bundle

The mount system bundle

See also

The networking system bundle

See also

The seat-manager system bundle

The system-bus system bundle

The udev system bundle

See also

The audio user bundle

The compositor user bundle

The default user bundle

The session-bus user bundle

The dbus-daemon service

The xdg-runtime-dir service

See also