commit 2e3058f97cdf870b43000fe2db4a8b3baae60cdf
parent 06f7b693f359ac12862b79fa8293708710dc6399
Author: Friedel Schön <[email protected]>
Date: Sun, 21 May 2023 01:16:58 +0200
implement the website
Diffstat:
4 files changed, 347 insertions(+), 315 deletions(-)
diff --git a/docs/assets/style.css b/docs/assets/style.css
@@ -2,11 +2,11 @@
body {
background: #eee;
- color: #3c3836;
+ color: #222;
}
body.dark {
- background: #3c3836;
+ background: #222;
color: #eee;
}
@@ -37,7 +37,7 @@ a:hover {
}
.title {
- color: #216477;
+ color: #772121;
font-weight: bold;
text-decoration: none;
font-size: 14pt;
@@ -48,7 +48,7 @@ a:hover {
}
.subtitle {
- color: #216477;
+ color: #772121;
text-decoration: underline;
}
@@ -58,7 +58,7 @@ a:hover {
.dark a.title,
.dark a.header {
- color: #339cba;
+ color: #ba3333;
}
#wrapper {
diff --git a/docs/assets/toggle-dark.js b/docs/assets/toggle-dark.js
@@ -4,10 +4,17 @@ function toggle_dark() {
if (document.body.classList.toggle('dark')) {
// is dark
githubImage.src = 'assets/github-mark-white.svg';
- toggleButton.innerHTML = ' licht aandoen ';
+ toggleButton.innerHTML = ' turn the lights on ';
} else {
// is light
githubImage.src = 'assets/github-mark.svg';
- toggleButton.innerHTML = ' licht uitdoen ';
+ toggleButton.innerHTML = ' turn the lights off ';
}
}
+
+document.addEventListener('readystatechange', function (state) {
+ if (document.readyState == 'complete')
+ if (window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches) {
+ toggle_dark();
+ }
+});
diff --git a/docs/index.html b/docs/index.html
@@ -2,7 +2,7 @@
<html lang=en>
<head>
- <title>Friedel Schön - Curriculum Vitae</title>
+ <title>Friedel's Initialization and Service Supervision</title>
<meta charset=utf-8 />
<meta name=viewport content='width=device-width,initial-scale=1' />
<link rel=stylesheet href=assets/style.css />
@@ -11,169 +11,387 @@
<body>
<div id=wrapper>
-<a class='header title' href=/>Friedel Schön - Curriculum Vitae</a> <span id=toggle_dark onclick=toggle_dark()> licht uitdoen </span> <a href=https://github.com/friedelschoen/><img id=github alt=GitHub src=assets/github-mark.svg /></a>
+<a class='header title' href='/fiss'>fiss</a> <span id=toggle_dark onclick=toggle_dark()> turn the lights on </span> <a href=https://github.com/friedelschoen/fiss><img id=github alt=GitHub src=assets/github-mark.svg /></a>
================================================================================
-<span id=about-me></span>
-Hoi, ik ben Friedel (Friedmund) Schön, ik ben nu 21 jaar en geboren te Aurich
-in Duitsland. Ik woon nu anderhalf jaar met plezier in Groningen. In mijn vrije
-tijd zit ik veel te programmeren, voornamelijk low-level in C. Ik heb C en vele
-andere talen zelf geleerd, begonnen was ik met BASH toen ik 15 jaar was. Aan
-programmeren vind ik leuk, dat ik creatief kan mensen helpen met software oplos-
-singen. Als ik niet zit de programmeren zit ik trompet te spelen in een orchest
-of ga met vrienden en een biertje doen. Ik vind dingen leren leuk op de manier
-learn-by-doing. Ik probeer mijn kennis te vergroten en kijk hoe dit gaat, C gaat
-heel goed met betrekking tot Linux utilities en dus zit ik heel veel daarmee te
-doen. Dit gaat niet alleen om programmeertalen maar ook protocollen en andere
-onderdelen. Ik wil graag deze dingen leren aan studenten en dus doe ik HBO-ICT
-om vervolgens in Nederland te blijven en te beginnen als docent op een hoge-
-school. Misschien begin ik ook bij een bedrijf met embedded programming. Aan
-mijn studie vind ik dingen zoals Assembly of Design leuk. Buiten school vind ik
-ook de gezelschap leuk, mijn meeste vrienden ken ik door deze opleiding.
-
-
-<a class=title id=contact href=#contact>Personalia</a>
---------------------------------------------------------------------------------
-
-<div id=contact-div><div id=contact-text>Naam: Friedel Schön
-E-Mail: <a href=mailto:[email protected]>[email protected]</a>
-Telefoon: <a href=tel:+31-6-2726-9331>+31 6 2726 9331</a>
-GitHub: <a href=https://github.com/friedelschoen>friedelschoen</a>
-
-Geboren: 18 juli 2001 te Aurich/Duitsland
-Nationaliteit: Duits
-</div><div id=contact-img><img id=me src=assets/friedel.png /></div></div>
+Aloha! You somehow landed on the website of <b>fiss</b> (<u>Friedel's Initialization and
+Service Supervision</u>). <b>fiss</b> is a supervision suite for Unix and Unix-like systems
+with the power off system initialization. This project is based on runit and
+other daemontools-based utilities.
-<a class=title id=diplom href=#diplom>Diploma's</a>
+<a class=title id=contact href=#contact>What does an init-system do?</a>
--------------------------------------------------------------------------------
-* Abitur (cf. VWO-diploma)
+After the kernel has loaded all the hardware stuff and setting up a working
+environment, it executes /sbin/init by default which mounts pseude-drives, the
+root-drive read-writable and more. This depends on your system, the package does
+include start and stop scripts and basic agetty services.
-* Nederlands als tweede taal (NT2)
+After the initialization is done, services must be started. A service is a long-
+running process, which needs to be restarted if it suddenly terminates. FreeBSD
+and other BSD's as far as I know, are handling services pretty rudimentally with
+plain shell scripts and without supervision. The most Linux distributions are
+shipped with SystemD which is the opposite of FreeBSD's rc.d idea. SystemD is
+one massive and bulky project with a lot of (useless) features. I've used Void
+Linux which is shipped with runit, a daemontools-derivate with initialization.
+Unlike SystemD, runit is a fine in-between: minimal but feature-rich. Bit too
+minimal so I thought of making fiss!
-* Rijbewijs B & BE
-
-<a class=title id=language href=#language>Taalvaardigheden</a>
+<a class=title id=diplom href=#diplom>Why fiss tho?</a>
--------------------------------------------------------------------------------
-* Duits (moedertaal)
-
-* Nederlands (B2-niveau)
+fiss is a lightweight and easy-to-use tool for initializing and supervising
+long-running services on Unix-like systems. It provides a simple and reliable
+way to start, stop, and monitor services. It supports automatic restarts,
+logging, and customizable startup options. It's no fork and uses the standard
+POSIX libc without other runtime dependencies. fiss support all the features to
+make services efficient running. It can be compatible with runit and daemontools
+utilities and is highly customizable at runtime to make fiss fit your needs.
-* Engels
-
-<a class=title id=programming href=#programming>Programmeervaardigheden</a>
+<a class=title id=diplom href=#diplom>fiss vs runit</a>
--------------------------------------------------------------------------------
-* C (hele syntax en standard library)
+runit is a good init-system and is lovely to use but there are some features
+which are just missing.
+
+* fiss has service-ordering (aka. dependencies), thus if service-b depends on
+ service-a, you can configure it as a dependency and fiss will keep service-a
+ running as long as service-b is running.
+
+* fiss has background-services, some services just won't let you run them in
+ foreground. runit solves this problem with <u>pause</u>, a little program which just
+ waits on an incoming signal. But this solution requires extra resources and
+ a process-slot. It's bearly possible to hit the process-roof but for every
+ process, the kernel needs to reserve memory and manage cpu-time.
+
+* runit has no built-in environment settings, it always runs services with a
+ clear environment and you can modify it with chpst. That extends the process
+ chain and cost more start-up time. fiss has build-in environment options for
+ changing the user and group, the arguments, argv[0] or environment-variables.
+ This project also includes a simplified and rewritten version of chpst, for
+ compatibility use.
+
+* runit's controller sv is really basic. It does not need to be very beautiful
+ or feature-rich, but enabling services and enabling services once (one time
+ after boot) is not possible. runit's <u>down</u>-file method seems more like a hack.
+ fiss supports enabling and once-enabling by default. If you like sv's
+ simplicity or its helpers like vsv or rsv, there is a compatibility-layer for
+ runit or daemontools.
+
+* finit and fsvc directly call the service executable. That means there is no
+ process-chaining as runit does. If you are running runit as init (runit-init):
+ - kernel executes runit-init
+ - this executes runit
+ - runit forks and executes /etc/runit/{1,2,3}
+ - /etc/runit/2 executes runsvdir
+ - runsvdir forks and executes runsv
+ - and finally runsv executes the underlying service executable
+
+ Every fork and execute causes an overhead. Also runsvdir is decentralized,
+ thus no central control unit can be used and every runsv has its own control
+ unit.
+
+ On the other hand this results in more security, if a executable failes due to
+ a bug, the underlying executable will catch this (if implemented). Which
+ implementation is better is up to yourself.
-* Python (hele syntax en standard library)
+* fiss and runit are entirely written in C, init has to be minimal and a garbage
+ collector would only slow down the whole system. With C you have direct
+ control of the operating system.
-* D (hele syntax en grotendeels standard library)
+* fiss is written from scratch using the libc implementaions, this results in a
+ readable code thus easier for contributers to dive into the codebase.
+ runit and daemontools are written using the djb-library which is an
+ alternative general library. It's completely fine to use the library and maybe
+ it is even faster than your libc-implementation (glibc, musl, freebsd-libc).
-* C++ (meeste syntax en grotendeels standard library)
-* BASH/ShellScript (meeste syntax en alle commands)
+<a class=title id=contact href=#contact>Installation</a>
+--------------------------------------------------------------------------------
-* HTML/CSS (hele syntax, geen goed design)
+Now that you are really hyped to install fiss, you first have to compile it.
-<span class=subtitle>Frameworks en Libraries:</span>
+To compile make sure you have installed the dependencies.
-* Arduino (C++)
+- C compiler like gcc or clang which supports the gnu99-standard
+- POSIX-compliant shell like dash or bash
+- GNU make
+- <a href='https://github.com/sunaku/md2man'>md2man</a> to make the manuals
-* Flask (Python)
+If running fiss, you require to have following dependencies installed:
+- POSIX-compliant shell like dash or bash
+- GNU awk
-<a class=title id=system href=#system>Systeemvaardigheden</a>
---------------------------------------------------------------------------------
+Download the last release from GitHub or clone this project with git to build
+from HEAD.
-* Linux
++------------------------------------------------------------------------------+
+| git clone https://github.com/friedelschoen/fiss.git |
++------------------------------------------------------------------------------+
-* macOS
+Then you have to compile the project with make.
-* BSD's (grotendeels)
++------------------------------------------------------------------------------+
+| make binary # to compile the executables |
+| make manual # to compile the manuals |
++------------------------------------------------------------------------------+
-* Windows (grotendeels)
+Executables are now stored in ./bin, standard configuration-files are stored in
+./etc, runtime-required files are in ./share and manuals in ./man.
-<a class=title id=study href=#study>Opleiding</a>
+<a class=title id=diplom href=#diplom>Getting Started</a>
--------------------------------------------------------------------------------
-* HBO-ICT: <a href=https://hanze.nl/>Hanzehogeschool Groningen</a> (sinds 2021)
+fiss does not parse any configuration file, everything is configured through
+different files inside for example /etc/service.d.
-* Gymnasium: <a href=https://igsaurich.de/>IGS Aurich-West</a> (2018 - 2021)
+Following files are executed by finit:
-* Middelbare: <a href=http://igsegels.de/>IGS Egels</a> (2012 - 2018)
+- /usr/share/fiss/start
+ This is the entry point of your system (similar to /etc/runit/1). By default
+ this script sources files in unix-order inside /etc/start.d/*.sh.
-* Basisschool: <a href=https://grundschule-mittegrossefehn.de/>Grundschule Mittegroßefehn</a> (2008 - 2012)
+- /etc/service.d/*
+ In this directory the services are stored, underneath is descripted how a
+ service is constructed. The utility fsvs is written to supervise a service-dir
+ without issuing start and stop mechanisms
+- /usr/share/fiss/stop
+ This is the ending point of your system-lifetime (similar to /etc/runit/3). By
+ default this script sources file in unix-order inside /etc/stop.d/*.sh.
-<a class=title id=work href=#work>Werkervaring</a>
---------------------------------------------------------------------------------
-
-* <a href=https://www.fiksi.nl/>Fiksi Computerhulp</a>: Expert (sinds 2021)
- - Kennis over vele onderwerpen qua computers
- - Helpen en uitleggen van oplossing (voornamelijk aan ouderen zonder kennis)
-
-* <a href=https://www.thuisbezorgd.nl/>Thuisbezorgd Groningen</a>: Bezorger (sinds 2021)
-
-* <a href=https://www.gamma.nl/bouwmarkten/groningen-peizerweg>GAMMA Groningen-West</a>: Vulploeg (2021)
+zzz is a utility shipped with fiss to suspend your system, following files are
+executed by zzz.
-* <a href=https://citipost-nordwest.de/>Citipost Nordwest</a>: Brievenbezorger in Ihlow (2020 - 2021)
- - Zelfstandigheid
- - Tijdplanning
+- /usr/share/fiss/suspend
+ This file is executed before suspending, by default this script sources
+ files in unix-order inside /etc/zzz.d/suspend/*.sh
-* <a href=https://www.edeka.de/eh/minden-hannover/edeka-center-bruns-dreekamp-18/index.jsp>E-Center Bruns Aurich</a>: Vulploeg en pakhuis (2019 - 2020)
-
-* <a href=https://www.nordwest-sonntagsblatt.de/epaper/aurich/>Heimat- & Sonntagsblatt</a>: Krantenbezorger in Ulbargen (2016 - 2018)
- - Zelfstandigheid
+- /usr/share/fiss/resume
+ This file is executed after suspending (thus before resuming), by default this script sources
+ files in unix-order inside /etc/zzz.d/resume/*.sh
-<a class=title id=internship href=#internship>Relevante Stages</a>
+<a class=title id=diplom href=#diplom>Getting Started</a>
--------------------------------------------------------------------------------
-* <a href=https://www.stadt-wiesmoor.de/>Stad Wiesmoor</a>: Systeembeheerder (2019)
+Services are usually placed into /etc/service.d, a services is a long-running
+executable like for example sshd, which should be running the whole lifetime of
+your system. Sadly do some services terminate before your system halts because
+of an error or signaling, this is where fiss plays its role.
+
+- ./run
+ Usually your service runs in the foreground, in this case you can create a run
+ executable, either linked to the actual binary or as a script that executes
+ the service. run is meant to be running the whole time in the foreground and
+ must not daemonize itself into the background as fiss would restart it.
+
+ +----------------------------------------------------------------------------+
+ | #!/bin/sh |
+ | |
+ | [ -r ./conf ] && . ./conf |
+ | |
+ | exec myservice $ARGS |
+ +----------------------------------------------------------------------------+
+
+ This example sources conf in the service-directory if present and executes
+ myservice with $ARGS.
+
+- ./params
+ run often needs parameters, these can be defined inside params. Your
+ arguments must be newline-demilitered. Usually the 0th argument is not
+ included and defaults to './run', but if you want to define the 0th argument
+ you can prefix the first line with '%' and the argument counting starts at 0.
+ No shell-substitution will be done.
+
+ +----------------------------------------------------------------------------+
+ | %fiss-service |
+ | -L |
+ | -p 8000 |
+ +----------------------------------------------------------------------------+
+
+ In this example, run would be executed with 'fiss-service' as 0th argument and
+ '-L' '-p 8000'
+
+- ./env
+ This file describes environment-variables for run. This is as params a
+ newline-demilitered file with key=value pairs. As for params, there is no
+ shell-substitution done.
+
+ +----------------------------------------------------------------------------+
+ | HOME=/home/foo |
+ | XDG_CONFIG_DIRS=/etc/ |
+ | PATH=/bin:/sbin:/usr/bin:/usr/sbin |
+ +----------------------------------------------------------------------------+
+
+- ./user
+ If this file is present, run will be executes as defined user and group(s).
+ You can define your user as 'user' and the group will be the user group or you
+ explicitly define 'user:group'. You can add multiple groups with
+ 'user:group:group2:group3', if user is prefixed with a colon (':'), users and
+ groups will be parsed as numeric thus ':1000:1000:1001'.
+
+ +----------------------------------------------------------------------------+
+ | foo:foo:mysql |
+ +----------------------------------------------------------------------------+
+
+ In this example, run would be executed as 'foo' and als 'foo' as group with
+ 'mysql' as additional group.
+
+- ./start
+ If your services cannot be run in the foreground, you should execute link it
+ to start, start is a short-running executable, if start exits it is considered
+ as running. To supervise your services, it's handy to provide a pid-file
+ inside your service as some services provide print its process-id to the
+ console. If no pid-file is found you must implement a stop file.
+
+ +----------------------------------------------------------------------------+
+ | #!/bin/sh |
+ | |
+ | myserver --print-pid > ./pid |
+ +----------------------------------------------------------------------------+
+
+- ./pid
+ This is a plain-text file containing just the PID of the service in decimal.
+
+- ./stop
+ This script is meant to stop the service, if this file exits the service is
+ considered inactive. This file must not coexist with pid.
+
+ +----------------------------------------------------------------------------+
+ | #!/bin/sh |
+ | |
+ | myserver2 --stop |
+ +----------------------------------------------------------------------------+
+
+- ./depends
+ This file contains newline-demilitered service-names which are dependencies of
+ the service. dependencies are started before the service will be started and
+ stopped if no enabled and no other service depend on it. Dependencies are just
+ started, no consideration will be done that the dependency is actually active.
+
+ +----------------------------------------------------------------------------+
+ | dbus |
+ | networking |
+ +----------------------------------------------------------------------------+
+
+- ./setup
+ If this file is present and executable, it will be executed before run or
+ start, it is meant for example to create files or directories.
+
+ +----------------------------------------------------------------------------+
+ | #!/bin/sh |
+ | |
+ | mkdir /var/myserver |
+ +----------------------------------------------------------------------------+
+
+- ./finish
+ If this file is present and executable, it will be executed after run has
+ exited or after stop was executed. This is meant to remove unnessasary files
+ or directories.
+
+ +----------------------------------------------------------------------------+
+ | #!/bin/sh |
+ | |
+ | rm -rf /var/myserver |
+ +----------------------------------------------------------------------------+
+
+- ./log
+ If this file is present, fiss will write the stdout and stderr of run to it.
+ This will be done without any modifications.
+
+- ./log/ service
+ If this directory is present and a valid service-directory, stdout and stderr
+ of your service will be redirected to the run of the log-service. This is done
+ with a internal pipe, thus no data will be lost of either services failes.
+
+- ./no-log
+ If this file is present, no logging will be done at all. This is meant for
+ very verbose services, which would overflout the system.
+
+ If log, log/ or no-log is not present, the output of will be redirected to
+ /run/fiss/log/<service>.
+
+- ./up-<runlevel>
+ If this file is present, the services will be started automatically and
+ restarted if this services dies. On other systems, this is called 'enabling'
+ a service.
+
+- ./once-<runlevel>
+ If this file is present, the services will be started automatically but not
+ restarted if this services dies.
+
+To be a valid service, run, stop or depends must be present. If only depends is
+present, this service is a dummy service thus no actual action will be taken but
+starting and stopping dependencies.
+
+start, stop, setup and finish are executed as the same user as fsvs or finit is
+started, thus root in the most cased. user, env, params are not read when
+handling a background-service. Every file will be executed in the services
+directory, reading a file like './conf' will be read out of the service
+directory.
+
+
+<a class=title id=diplom href=#diplom>Controlling Services</a>
+--------------------------------------------------------------------------------
-* <a href=https://www.buenting.de/en>Bünting Leer-Nortmoor</a>: Systeembeheerder (2018)
+To control a service, you can use fsvc. fsvc connects to the control-socket and
+controls the services. How a command and a serialized service is defined is
+stated in docs/internal/.
-* <a href=https://www.orgadata.com/nl>ORGADATA Leer</a>: Software Engineer (2017)
+fiss supports runit or daemontools' sv, if you are used to your fancy sv-
+implementation, you still can but keep in mind that even runit's sv only has
+limited functionality compared to fsvc.
-* <a href=https://www.hr4you.de/en/company>HR4YOU Timmel</a>: Software Engineer (2016)
+Following commands are present:
+- status [--short] [--check] [service]
+ Use this command to query a service. If service is omitted, every services
+ is printed. If issued with check, nothing will be printed and the return-code
+ is 0 if the service is active, otherwise 1. If issued with short, a table will
+ be printed rather than a list. Wildcards can be used with '*' for variable-
+ length and '%' for any character.
-<a class=title id=projects href=#projects>Mijn Projecten</a>
---------------------------------------------------------------------------------
+- start [--pin] <service>
+ With start, you obviously start a service but if your service is not enabled
+ it will stop if it failes. You can pin this services as enabled manually,
+ the services will be restarted for this session only.
-* <a href=https://github.com/friedelschoen/importsort-d>importsort-d</a>: een utility voor de programmeertaal D om imports alfanumeriek
- te sorteren
+- stop [--pin] <service>
+ You stop a services, but if you services is already enabled (either manually
+ or through a up-* file) or is a dependency of something, it will be restarted
+ instantly. To force this services as down, you must pin it.
-* <a href=https://github.com/friedelschoen/dualinit>DualINIT</a>: een meta-init systeem voor Linux
+- enable [--once] <service> and disable [--once] <service>
+ This is a helper for creating up-<runlevel> or once-<runlevel>. If issued
+ without once, a up-* file will be created. If issued with once, a once-* file
+ will be created. The service directory should be refreshed a moment after.
-* <a href=#>paccat</a>: een Linux package-manager, die probeert verschil- <b>(nog geen release)</b>
- lende package-managers samen te voegen
-
-* <a href=https://github.com/MoiBaguette/Webtechnologie-Project/>Programmeerles voor Ouderen</a> (school-project van jaar 1): een website front- en
- backend voor het beheren van programmeerlessen voor ouderen
+- kill <service> <signal>
+ With this command, you can send a signal to the service executable. No
+ consideration will be done, thus sending SIGSTOP will not set the pause-flag.
+ As a signal, you can use the number (9 as SIGKILL), the unix identifier like
+ KILL or prefixed with 'SIG' thus SIGKILL.
-* <a href=https://github.com/friedelschoen/muizenval.tk/>Muizenval.tk</a> (school-project van jaar 1): website en embedded software voor
- een <i>slimme</i> muizenval voor <a href=https://www.5groningen.nl/>5Groningen</a>
+- pause <service> and resume <service>
+ This pauses or resumes a services, SIGSTOP or SIGCONT will be sent to the
+ executable and the pause-flag is set.
-* <a href=https://github.com/friedelschoen/java-game-client/>Java Game Client</a> (school-project van jaar 2): een cliënt <b>(nog geen release)</b>
- voor TicTacToe en Othello
+- switch [--reset] <service>
+ This switches the runlevel, all services that are enabled by file will be
+ stopped. If issued with reset also all services will be stopped that were
+ enabled manually with start --pin.
================================================================================
- -*- <i>Deze website is gebaseerd op <a href=https://kisslinux.org/>Kiss Linux</a>' website (MIT gelicenseerd)</i> -*-
+ -*- <i>This website is based on <a href=https://kisslinux.org/>Kiss Linux</a>' website (MIT gelicenseerd)</i> -*-
</div>
-<script type=text/javascript>
- if (window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches) {
- toggle_dark();
- }
-</script>
</body>
</html>
\ No newline at end of file
diff --git a/readme.md b/readme.md
@@ -1,214 +1,21 @@
-# FISS (Friedel's Initialization and Service Supervision)
+# fiss (Friedel's Initialization and Service Supervision)
> 0.2.2 (May 2023)
-FISS is a lightweight and easy-to-use tool for initializing and supervising long-running services on Unix-like systems. It provides a simple and reliable way to start, stop, and monitor services. It supports automatic restarts, logging, and customizable startup options.
+fiss is a lightweight and easy-to-use tool for initializing and supervising long-running services on Unix-like systems. It provides a simple and reliable way to start, stop, and monitor services. It supports automatic restarts, logging, and customizable startup options.
-FISS is inspired by tools like [runit](http://smarden.org/runit/) and [daemontools](http://cr.yp.to/daemontools.html), but it aims to be simpler and more flexible, while still providing a similar level of reliability and security.
+fiss is inspired by tools like [runit](http://smarden.org/runit/) and [daemontools](http://cr.yp.to/daemontools.html), but it aims to be simpler and more flexible, while still providing a similar level of reliability and security.
## Features
-FISS provides the following features:
+fiss provides the following features:
-- Automatic restarts: If a service exits unexpectedly, FISS will automatically restart it, up to a configurable number of times.
-- Logging: FISS captures the stdout and stderr of the service and writes them to log files, which can be rotated and compressed.
-- Customizable startup options: FISS allows you to specify environment variables, working directory, umask, and other options for the service.
-- Supervision: FISS monitors the service and ensures that it stays running, or else it terminates the service and retries later.
-- Status monitoring: FISS provides a simple command-line interface to check the status of a service, including its uptime, PID, and exit code.
-- Simple configuration: FISS uses a simple directory structure to store the configuration for each service, making it easy to manage and version control.
-
-## Dependencies
-
-- a POSIX shell compliment like `dash` or `bash`
-- `awk`
-
-## Installation
-
-FISS is written in C and POSIX Shell. To compile this project, the following tools are required:
-
-- `gcc` (or a gcc-compatible compiler like `clang`)
-- `make`
-- [`md2man-*`](https://github.com/sunaku/md2man) to make the manuals
-
-To compile the project simply run:
-
-```sh
-$ make # to compile everything
-$ make binary # to compile just the executables
-$ make manual # to compile the manuals
-```
-
-Then copy the contents of `bin/` to `/sbin/`, `usr/*` to `/usr/` and `etc/` to `/etc/`, the manuals are in `man`, copy them to `/usr/share/man/man8`.
-
-## Usage
-
-To use FISS, you need to create a configuration directory for each service you want to supervise.
-
-A service directory must contain either of these files: `run`, `start`, `depends`
-
-```
-/etc/service.d/my-service/
-├── log/
-├── nolog
-├── log
-├── depends
-├── env
-├── finish
-├── params
-├── pid
-├── run
-├── setup
-├── start
-├── stop
-├── user
-├── <runlevel>-once
-└── <runlevel>-up
-```
-
-### `run`
-
-The `run` file should be marked as executable and is meant be a long-running service. This can be a symbolic link to an executable or a simple script that executes.
-
-It must not coexist with `start`.
-
-```sh
-#!/bin/sh
-
-USER=hello
-PASSWORD=world
-
-exec python3 my-service.py $USER $PASSWORD
-```
-
-### `start`
-
-This file initiates a long-running background-service. This can be a symbolic link to an executable or a simple script.
-
-It must not coexist with `run`.
-
-If `start` exist, either `stop` or `pid` must exist to let fiss terminate a service, the function of those files is described beneath. `pid` is stat and read after `start` exits.
-
-If your service provides an foreground-running interface, it's advised to use this in combination with `run` as it's easier to supervise a foreground-process!
-
-```sh
-#!/bin/sh
-
-myservice --daemon > ./pid # myservice prints it's PID to stdout
-```
-
-### `stop`
-
-This file is meant to stop a background-service and will be executed whenever a service should terminate a background service.
-
-It may not coexist with pid.
-
-```sh
-#!/bin/sh
-
-myservice --stop
-```
-
-### `pid`
-
-This file contains the pid of a background service in decimal.
-
-### `depends`
-
-This file contains a newline-terminated list of services that should be running before this service is started. A service can only contain this file, it will be considered a meta-service.
-
-```
-dbus
-NetworkManager
-```
-
-### `nolog`
-
-By default FISS logs all services without a `log` file or directory inside _/var/log/fiss/\<service>.log_. If this file is present, this services will not be logged.
-
-This is useful for very verbose daemons, which would cause gigabytes of log-files.
-
-### `log/` directory
-
-If `log` is a directory, it should contain a service, the output or the service (if running as a foreground-service) will be redirected to the `run` of your log-service.
-
-The log-service is a dependency of your service. If the service or the log-service unexpectedly terminates, no data will be lost as data is buffered.
-
-### `log` file
-
-Output of the service is redirected to this file if existing. This can be used for simple services with no time-specific output as nothing but the output is redirected.
-
-If formatting or time-prefixed are wished, consider using a log-service.
-
-### `user`
-
-If existing, `start` of `run` will be executed as this user (and optionally a group). The contents should be in format `<user>[:<group>:<group...>]` or `<uid>:<gid>[:<gid...>]`
-
-```
-fiss-user:fiss-user
-```
-
-### `env`
-
-If existing, environment-variables will be passed to `run` or `start`. This is a simple `key=value`-file with **no variable-substitution**.
-
-```
-HOME=/home/fiss-user/
-THREADS=16
-BE_COOL=yes
-```
-
-### `params`
-
-If existing, arguments are passed to `run` or `start`. Every line is considered an argument and **no variable-substitution** is applied.
-
-If the first line starts with a `%` (percent sign), the 0th argument is set, otherwise this list begins with the first argument and `argv[0]` stays `'./run'`
-
-```
-%mysql
--u
-cool user
--p
--d
-```
-
-which is equivalent to the shell-call:
-
-```
-mysql -u 'cool user' -p -d
-```
-
-### `setup`
-
-This file is executed before `start` or `run` is called with an unchanged environment (thus `root`). It's useful for e.g. creating files which is not permitted by the user specified in `user`.
-
-```sh
-#!/bin/sh
-
-mkdir /run/myservice/
-chmod a+rw /run/service
-```
-
-### `finish`
-
-This file is executed after `run` or `stop` with an unchanged environment (thus `root`). It's useful for e.g. cleaning up files which is not permitted by the user specified in `user`.
-
-```sh
-#!/bin/sh
-
-rmdir /run/myservice/
-```
-
-### `<runlevel>-up` and `<runlevel>-once`
-
-If this file is present, this service is started if `finit` is running with specified `runlevel`. If `-up` is present, this service will be restarted whenever it terminated. If `-once` is present, it will be started once and not restarted on exiting.
-
-Both `<runlevel>-up` and `<runlevel>-once` must not coexist.
-
-## Controlling
-
-To control fiss (e.g. `finit` and `fsvs`) you use `fsvc` (friedel's service controller).
-
-For further information check out [the manual](man/fsvc.8.md).
+- Automatic restarts: If a service exits unexpectedly, fiss will automatically restart it, up to a configurable number of times.
+- Logging: fiss captures the stdout and stderr of the service and writes them to log files, which can be rotated and compressed.
+- Customizable startup options: fiss allows you to specify environment variables, working directory, umask, and other options for the service.
+- Supervision: fiss monitors the service and ensures that it stays running, or else it terminates the service and retries later.
+- Status monitoring: fiss provides a simple command-line interface to check the status of a service, including its uptime, PID, and exit code.
+- Simple configuration: fiss uses a simple directory structure to store the configuration for each service, making it easy to manage and version control.
## Licensing
