1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
|
<!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>goetia-base</title>
<meta name="Description" content="goetia-base contains kernel independent basic building blocks of goetia." />
<meta name="Keywords" content="goetia base" />
</head>
<header>
<p>
<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>goetia-base</h1>
<h2>What is it?</h2>
<p>
goetia-base contains scripts to manage
<a href="//0x53.net/software/goetia/supervisiontree.html#system">system</a>.
and
<a href="//0x53.net/software/goetia/supervisiontree.html#user">system supervision trees</a>.
Additionally, it contains kernel independant
<a href="https://skarnet.org/software/s6/servicedir.html">service directories</a>
and
<a href="https://skarnet.org/software/s6-rc/s6-rc-compile.html#source">source directories</a>
for the system and user supervision tree.
</p>
<hr>
<h2>Installation</h2>
<h3>Requirements</h3>
<ul>
<li>
A set of POSIX tools as described in the general
<a href="//0x53.net/software/requirements.html">requirements</a>
</li>
<li>
A POSIX-compliant implementation of make, or GNU make
</li>
<li>
Additional per-service dependencies,
e.g. the daemon itself the service corresponds to,
are listed on the respective page of the service.
</li>
</ul>
<h3>Licensing</h3>
<p>
goetia-base is free software. It is available under the
<a href="https://opensource.org/licenses/ISC">ISC license</a>.
</p>
<h3>Download</h3>
<ul>
<!--
<li>
The current released version of goetia-base is
<a href="./goetia-base-0.0.1.0.tar.gz">0.0.1.0</a>.
You can access its checksum
<a href="./goetia-base-0.0.1.0.tar.gz.sha256">here</a>.
</li>
-->
<li>
Alternatively, you can checkout a copy of the
<a href="https://git.0x53.net/goetia-base">goetia-base git repository</a>:
<pre>git clone git://git.0x53.net/goetia-base</pre>
</li>
</ul>
<h3>Compilation</h3>
<ul>
<li>
See the enclosed INSTALL file for installation details.
</li>
</ul>
<hr>
<h2>Reference</h2>
<section id="bin">
<h3>Commands</h3>
<p>
All of the following are
<a href="https://skarnet.org/software/execline/">execline</a>
scripts.
Most of these commands are thin wrappers
around tools from
<a href="https://skarnet.org/software/s6/">s6</a>
and
<a href="https://skarnet.org/software/s6-rc/">s6-rc</a>.
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.
</p>
<h4>Managing system supervision trees</h4>
<ul>
<li>
<a href="./bin/system-db.html">system-db</a>
</li>
<li>
<a href="./bin/system-ml.html">system-ml</a>
</li>
<li>
<a href="./bin/system-rc.html">system-rc</a>
</li>
<li>
<a href="./bin/system-run.html">system-run</a>
</li>
</ul>
<h4>Managing user supervision trees</h4>
<ul>
<li>
<a href="./bin/user-db.html">user-db</a>
</li>
<li>
<a href="./bin/user-ml.html">user-ml</a>
</li>
<li>
<a href="./bin/user-rc.html">user-rc</a>
</li>
<li>
<a href="./bin/user-run.html">user-run</a>
</li>
<li>
<a href="./bin/user-init.html">user-init</a>
</li>
<li>
<a href="./bin/user-shutdown.html">user-shutdown</a>
</li>
<li>
<a href="./bin/user-tmpfs.html">user-tmpfs</a>
</li>
</ul>
<h4>Utility scripts</h4>
<ul>
<li>
<a href="./bin/compile-db.html">compile-db</a>
</li>
<li>
<a href="./bin/longrun-make.html">longrun-make</a>
</li>
<li>
<a href="./bin/oneshot-make.html">oneshot-make</a>
</li>
<li>
<a href="./bin/prepare-svscan.html">prepare-svscan</a>
</li>
<li>
<a href="./bin/system-shutdown-daemon.html">system-shutdown-daemon</a>
</li>
</ul>
</section>
<section id="service">
<h3>Service directories</h3>
<p>
Service directories for early and basic services,
used without
<a href="https://skarnet.org/software/s6-rc/">s6-rc</a>.
Service directories in this package are used independent
of the kernel in use.
</p>
<h4>System service directories</h4>
<ul>
<li>
<a href="./service/system/goetia-runner.html">goetia-runner</a>
</li>
<li>
<a href="./service/system/s6-svscan-log.html">s6-svscan-log</a>
</li>
<li>
<a href="./service/system/s6-svscan-log-console.html">s6-svscan-log-console</a>
</li>
</ul>
<h4>User service directories</h4>
<ul>
<li>
<a href="./service/user/.s6-svscan.html">.s6-svscan</a>
</li>
<li>
<a href="./service/user/goetia-runner.html">goetia-runner</a>
</li>
<li>
<a href="./service/user/goetia-shutdown.html">goetia-shutdown</a>
</li>
<li>
<a href="./service/user/s6-svscan-log.html">s6-svscan-log</a>
</li>
</ul>
</section>
<section id="source">
<h3>Source directories</h3>
<p>
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
<a href="//0x53.net/software/goetia/tutorials/">tutorial page</a>.
</p>
<h4>System source directories</h4>
<h5>bundle</h5>
<p>
Some services can be provided by multiple different implementations.
Those are abstracted by bundles,
which can be filled with the desired implementation.
For the
<a href="//0x53.net/software/goetia/supervisiontree.html#system">system supervision tree</a>
the bundles used and provided by default in goetia are:
</p>
<ul>
<li>
<a href="./source/system/bundles/default.html">default</a>
</li>
<li>
<a href="./source/system/bundles/mount.html">mount</a>
</li>
<li>
<a href="./source/system/bundles/udev.html">udev</a>
</li>
<li>
<a href="./source/system/bundles/seat-manager.html">seat-manager</a>
</li>
<li>
<a href="./source/system/bundles/system-bus.html">system-bus</a>
</li>
<li>
<a href="./source/system/bundles/networking.html">networking</a>
</li>
<li>
<a href="./source/system/bundles/firewall.html">firewall</a>
</li>
</ul>
<h5>cron</h5>
<ul>
<li>
dcron
</li>
</ul>
<h5>db</h5>
<ul>
<li>
mariadb
</li>
<li>
mysqld
</li>
</ul>
<h5>net</h5>
<ul>
<li>
dhcpcd
</li>
<li>
wpa_supplicant
</li>
</ul>
<h5>ntp</h5>
<ul>
<li>
chronyd
</li>
</ul>
<h5>web</h5>
<ul>
<li>
gate
</li>
<li>
nginx
</li>
<li>
radicale
</li>
</ul>
<h5>other</h5>
<ul>
<li>
cupsd
</li>
<li>
dbus-daemon
</li>
<li>
<a href="./source/system/admin/seatd.html">seatd</a>
</li>
<li>
sshd
</li>
</ul>
<h4>User source directories</h4>
<h5>bundle</h5>
<p>
Some services can be provided by multiple different implementations.
Those are abstracted by bundles,
which can be filled with the desired implementation.
For the
<a href="//0x53.net/software/goetia/supervisiontree.html#user">user supervision tree</a>
the bundles used and provided by default in goetia are:
</p>
<ul>
<li>
<a href="./source/user/bundle/default.html">default</a>
</li>
<li>
<a href="./source/user/bundle/audio.html">audio</a>
</li>
<li>
<a href="./source/user/bundle/compositor.html">compositor</a>
</li>
<li>
<a href="./source/user/bundle/session-bus.html">session-bus</a>
</li>
</ul>
<h5>audio-daemon</h5>
<ul>
<li>
pipewire
</li>
<li>
pipewire-pulse
</li>
<li>
wireplumber
</li>
</ul>
<h5>clipboard-manager</h5>
<ul>
<li>
wl-clip-persist
</li>
</ul>
<h5>compositor</h5>
<ul>
<li>
Hyprland
</li>
</ul>
<h5>desktop-widget</h5>
<ul>
<li>
waybar
</li>
<li>
yambar
</li>
</ul>
<h5>notification-daemon</h5>
<ul>
<li>
dunst
</li>
<li>
fnott
</li>
<li>
mako
</li>
<li>
swaync
</li>
</ul>
<h5>wallpaper-daemon</h5>
<ul>
<li>
hyprpaper
</li>
</ul>
<h5>xdg</h5>
<ul>
<li>
xdg-desktop-portal-hyprland
</li>
<li>
xdg-desktop-portal
</li>
<li>
xdg-document-portal
</li>
<li>
xdg-permission-store
</li>
<li>
<a href="./source/user/xdg/xdg-runtime-dir.html">xdg-runtime-dir</a>
</li>
</ul>
<h5>other</h5>
<ul>
<li>
at-spi-bus-launcher
</li>
<li>
at-spi2-registryd
</li>
<li>
<a href="./source/user/other/dbus-daemon.html">dbus-daemon</a>
</li>
<li>
dconf-service
</li>
<li>
foot
</li>
<li>
mpd
</li>
</ul>
</section>
</body>
</html>
|
