Date: Sat, 7 Feb 2026 10:20:30 +0100 Subject: Add doc --- doc/index.html | 413 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 413 insertions(+) create mode 100644 doc/index.html (limited to 'doc/index.html') diff --git a/doc/index.html b/doc/index.html new file mode 100644 index 0000000..fe07e2b --- /dev/null +++ b/doc/index.html @@ -0,0 +1,413 @@ + + + + + + + goetia-base + + + +

+ goetia +
+ Software +
+ 0x53.net +

+ +

goetia-base

What is it?

+ goetia-base contains scripts to manage + system. + and + system supervision trees. + Additionally, it contains kernel independant + service directories + and + source directories + for the system and user supervision tree. +

Installation

Requirements

+ A set of POSIX tools as described in the general + requirements +
+ A POSIX-compliant implementation of make, or GNU make +
+ Additional per-service dependencies, + e.g. the daemon itself the service corresponds to, + are listed on the respective page of the service. +

Licensing

+ goetia-base is free software. It is available under the + ISC license. +

Download

+ Alternatively, you can checkout a copy of the + goetia-base git repository: +
```
git clone git://git.0x53.net/goetia-base
```
+

Compilation

+ See the enclosed INSTALL file for installation details. +

Reference

Commands

+ All of the following are + execline + scripts. + Most of these commands are thin wrappers + around tools from + s6 + and + s6-rc. + They do not do much more than supplement the former + with the right paths and default options. + The utility scripts, however, + contain their own logic that is used + in some of the other scripts. +

Managing system supervision trees

+ system-db +
+ system-ml +
+ system-rc +
+ system-run +

Managing user supervision trees

+ user-db +
+ user-ml +
+ user-rc +
+ user-run +
+ user-init +
+ user-shutdown +
+ user-tmpfs +

Utility scripts

Service directories

+ Service directories for early and basic services, + used without + s6-rc. + Service directories in this package are used independent + of the kernel in use. +

System service directories

User service directories

Source directories

+ Following is a list of included + source directories. + Note that some daemons are so modular + and configurable, it would be nonsense + to provide a "stock" source directory. + How to set those up is explained in + an according + tutorial page. +

System source directories

bundle

+ Some services can be provided by multiple different implementations. + Those are abstracted by bundles, + which can be filled with the desired implementation. + For the + system supervision tree + the bundles used and provided by default in goetia are: +

+ default +
+ mount +
+ udev +
+ seat-manager +
+ system-bus +
+ networking +
+ firewall +

cron

+ dcron +

db

+ mariadb +
+ mysqld +

net

+ dhcpcd +
+ wpa_supplicant +

ntp

+ chronyd +

web

+ gate +
+ nginx +
+ radicale +

other

+ cupsd +
+ dbus-daemon +
+ seatd +
+ sshd +

User source directories

bundle

+ Some services can be provided by multiple different implementations. + Those are abstracted by bundles, + which can be filled with the desired implementation. + For the + user supervision tree + the bundles used and provided by default in goetia are: +

+ default +
+ audio +
+ compositor +
+ session-bus +

audio-daemon

+ pipewire +
+ pipewire-pulse +
+ wireplumber +

clipboard-manager

+ wl-clip-persist +

compositor

+ Hyprland +

desktop-widget

+ waybar +
+ yambar +

notification-daemon

+ dunst +
+ fnott +
+ mako +
+ swaync +

wallpaper-daemon

+ hyprpaper +

xdg

+ xdg-desktop-portal-hyprland +
+ xdg-desktop-portal +
+ xdg-document-portal +
+ xdg-permission-store +
+ xdg-runtime-dir +

other

+ at-spi-bus-launcher +
+ at-spi2-registryd +
+ dbus-daemon +
+ dconf-service +
+ foot +
+ mpd +

+ + -- cgit v1.2.3