ACM/3S-Orchestration - Codeberg.org

Archive: %: Merged with
https://codeberg.org/ACM/Domain_Specific_Utility_Environment
/ System Setup Scripts (for Debian)
 As a note, this project is currently in a preview state, and most of its
modules are not yet available; these modules will be made available
incrementally as their functionality progresses. Furthermore, the modules are
separated between multiple repositories, as they are intended to function
independently. For example, this README is in the 3S-Orchestration repository,
which is purely for retrieving other components and combining them to create the
specified system.
 A set of scripts that make many configuration changes to both the Debian
installation process and the installed system; these changes include skipping
certain installer options with sane and secure defaults automatically, such as
encrypted partitions with sufficient swap for hibernation and no root-user
access; installing a large swath of firmware and drivers immediately, providing
options for different environments, and being portable and modular, so the
scripts can run on an existing system. As well as this, the installation can
install various utilities for managing repositories and configuring containers
to provide a sandboxed environment for external package installations. Refer to
the documentation for the full range of utilities provided.
 Some are the installation options are as follows: running scripts on a live
system, installing from a custom ISO image, preseeding from a default ISO image,
running debootstrap, then running the scripts; or any other method of installing
Debian, since the scripts can be run independently. With these changes, this
setup is still smaller and more modular than large hard-distributions of Debian;
this version is a soft-distribution, so it uses Debian repositories.
 Other notes on changes and utilities:
 
 See the package lists in ./src for an extensive manifest of what is
 installed.
 
 + The embedded configuration provides a minimal Debian installation
 with options for kiosk packages.
 
 + The server configuration provides basic networking packages.
 
 + Workstation setting provides either a window manager or KDE with
 quality-of-life changes.
 
 + Utilities to assist in re-constructing and package the ISO and
 programs used by this set of scripts, including compiling by source if
 the Debian Bookworm binaries are no longer available for any reason.
 As opposed to other methods of automating the process, shell scripting was
chosen for the reasons of portability and that it can be run from an installer.
POSIX shells also have standardized programs included that significantly
simplify the process.
 The script is meant to be somewhat general purpose; it can be used on many
different types of systems, including virtual machines, special-purpose/embedded
devices (such as a kiosk), servers, handhelds, and workstations.
 Meant to run either during the installation or after, this configurable
script automatically installs numerous base packages, drivers, and other
components for convenience; the script will set a number of reasonable defaults
as well.
 In comparison to other scripts and distributions, this project leaves the
presentation and general behavior of the system untouched; instead, defaults
are mostly used with minor tweaks to simplify use and offer increased platform
support by installing drivers and firmware from both Debian and outside sources
to maximize compatibility with new and old hardware. Hardware incompatibilities
are counted as bugs for this project. If a piece of hardware is not functioning
as expected after this installer, a request may be opened for the 3S to install
the required programs automatically. Continuing, it is a goal of this project to
make newer systems have the ability to run this soft-distribution of Debian,
since it has all the added benefits of the minimal and tailorable system without
going to hard-distributions that remove portability and make major alterations
to the base system.
 Adding on, there are more than just compatibility scripts provided by this
project; in fact, most of the scripts are likely for various changes and
additions that simplify use or make actions that would be taken by the
administrator anyway. All of these changes are modular and optional.
 The scripts include additional textual and graphical utilities as well.
 See documentation for more details on use.
// Installation
 Post-Install script.
	1.) Place the repository contents in the desired directory.
	2.) Edit the "src/conf-install" file to set the specified parameters.
	3.) Run the "install.sh" file to initiate the installation.
// Scope
 1.) In order to maintain portability between shells, the script only employs
the use of "if" and basic POSIX programs located in the system's path
directories; comments are placed on separate lines.
 2.) To ensure hardware compatiblity, the script installs numerous packages
containing drivers and firmware. As well as this, it pulls remote packages to
obtain the newest firmware, drivers, and kernel.
 3.) To setup a reliable installation, the script only installs components
and configurations that are stable, as in experiencing little change; simple, as
in easy to use and unobtrusive; and minimal, as in having a small footprint or
small effect on the system; such as basic packages for managing the OS or
environment.
 4.) For configuration, the script has a configuration file to permit easy
modification to its behavior.
 5.) In use, the resulting system should have no annoyances, such as random
pop-ups; everything should have as few steps as possible. A wide variety of
scripts are placed on the system to automate certain processes as the system is
used; the design should be predictable.
 6.) To maintain simplicity, the implementation is limited to the script;
this script can be embedded in an ISO image file, or can be run post-install.
Limiting the scope is a catalyst for efficient production, since the effort is
placed entirely on the core component without the overhead of designing an
entire environment, such as Debian, which is the base of these scripts because
of its versatility and minimal footprint.
 The objective is for the design to be predictable, simple, adaptable,
succinct, and incremental in its changes.
 See the documentation for more information on the scripts configurations,
post-installation behavior, and installed programs.
+/