The Horizon UI is the wizard-style user interface component of Project Horizon. The system takes the input of the User and creates a HorizonScript. The resultant HorizonScript is either executed on the running system when started in an installation environment, or saved for later use when started in a runtime environment.

This section describes the boot-up and initialisation procedures for the Horizon UI Installation Environment.

If the User has specified to load firmware in the installation environment, the system shall install the linux-firmware package to the installation environment before eudev is started. The system shall detect all usable graphics adaptors present in the computer. If there are no usable graphics adaptors present, the system shall display a message that installation cannot continue, and allow the User to login to a virtual TTY or reboot the computer. If multiple graphics adaptors are present, the system shall attempt to determine which graphics adaptor has a monitor attached. If the determiniation is that multiple graphics adaptors have monitors attached, or it is indeterminiate which adaptor has a monitor attached, then the system shall prompt the User to choose which graphics adaptor to use for installation.

The system must obey these requirements on all screens, except where explicitly noted.

The system shall display a Cancel button on every screen. If the User chooses the Cancel button, the system shall confirm that the User wishes to cancel installation. The system shall additionally explain that no data has been modified yet, and that cancelling installation will cause the computer to reboot. If the User chooses to confirm cancellation of the installation, the system shall reboot the computer. The system shall display a Back button on every screen except the initial screen, which will move the User back to the previous screen. If the User chooses to go back to a previous screen, the system shall save any changes the User has made to the current screen before moving back to the previous screen. The system shall then redisplay those changes when the current screen is shown again.

A User must determine what natural language they are most comfortable with using for installing Adélie Linux. The system will allow the User to select their preferred natural language from a list of the languages to which the system has been translated. Priority: Medium.

The system must have more than one language translation available for use.

The system shall present the User with a list of natural languages, in the form of: "Install Adélie using English", "Installer Adélie en français". For this screen only, the system shall present the "Next" button as a single right-facing arrow. The system shall not present the Cancel button on this screen. When the User chooses a language from the list, the system shall enable the Next button to be clicked.

language — The locale identifier of the chosen language.

The system will explain to the User an overview of the installation process, and introduce common UI elements. A User may choose to run a tool or proceed with the installation.

The system shall present the User with a greeting message including a high-level overview of the installation process. The system shall reassure the User that the installation process will not modify any data until the final step. The system shall describe the UI elements common to each screen, including the Help button, the Back/Next buttons, and the Cancel button. The system shall allow the User to start a tool from the following list before beginning the installation. A terminal. An external partition editor. A lightweight Web browser.

A User may have a keyboard that is not the Linux default of US QWERTY. As such, a User must be able to choose a keyboard layout that matches their hardware.

The system shall present the User with a list of available keyboard layouts. When the User selects a keyboard layout, the system shall load the keyboard layout and apply it. The system shall present an input box for the User to test their selected keyboard layout.

keymap — The identifier of the chosen keyboard layout.

A User may possess hardware that requires non-free binary firmware to operate. This screen will allow the User to choose whether to load such firmware or not. Note that this feature can be compiled out of Horizon UI, and can also be disabled at run-time with a configuration setting.

The system must have firmware support compiled in.

The system shall ask the User whether or not to load binary firmware, stressing that security-sensitive systems must not choose this option. If the User chooses to load binary firmware, the system shall add the APK Fission repository and the linux-firmware package to the installed environment.

firmware — Whether to load firmware.

Most Users will want to configure a network connection on their computer. The system will allow the User to configure their wired or wireless network connection, including authentication information (wireless), IP v4 and v6 addressing, routing, and DNS.

The system must have at least one non-loopback network interface detected by the kernel.

The system shall ask the User whether they wish to use automatic addressing (DHCP), manual addressing, or disable network connectivity. The system shall not allow the User to disable network connectivity if any required repository is unavailable locally. If the User chooses to disable network connectivity, the system shall proceed to the System Metadata screen. If Horizon UI is running in a runtime environment instead of an installation environment, the system shall allow the User to add their network interface by device name before proceeding. If the computer has more than one network interface, the system shall prompt the User to choose which interface to use for installation. If the chosen network interface is a wireless network interface, the system shall display a Wireless Configuration screen. The system shall allow the User to disable wireless connectivity. If the User has chosen to disable wireless connectivity, and the computer has multiple network interfaces, the system shall start at UI.Network.ChooseIface again. If the User has chosen to disable wireless connectivity, and the computer only has wireless networking, the system shall prompt the User to confirm they wish to continue without networking. The system shall display a list of access points in range of the wireless interface for the User to select from. The system shall allow the User to input a custom access point name. If the chosen access point uses authentication, the system shall prompt the User for the requisite credentials. If the User inputs a custom access point name, the system shall prompt the User for the type of security used (or none) and requisite credentials. The system shall enable the Next button when an access point is selected or input, and the requisite credentials (if any) have been input. When the User chooses Next, the system shall attempt to connect to the specified wireless network. If an error occurs during wireless network connection, the system shall display a message explaning the error condition, and redisplay the Wireless Configuration screen. The system shall time out after waiting 15 seconds for the wireless network to connect, and consider a time out an error condition as specified in UI.Network.Wireless.Error. If the User selected automatic addressing, the system shall attempt to obtain an IPv4 address via DHCP and an IPv6 address via Router Advertisement and DHCPv6. If no IP address is obtained for v4 or v6 after 15 seconds, the system shall display a message that automatic configuration failed, and ask the User whether to retry the attempt, use manual addressing, or skip networking configuration. If the User selected manual address, the system shall prompt the User for the following information: Information Description IPv4 host address The address of this computer IPv4 subnet mask The subnet mask / prefix of the network IPv4 default gateway The router on the network IPv4 DNS resolver The DNS resolver to use on IPv4 networks; default to 9.9.9.9 IPv6 host address The address of this computer IPv6 network prefix The prefix of the network IPv6 default gateway The router on the network IPv6 DNS resolver The DNS resolver to use on IPv6 networks; default to 2620:fe::fe The system shall allow the User to test their network configuration by attempting to connect to distfiles.adelielinux.org. The system shall enable the Next button when either an IPv4 or IPv6 configuration is complete (address, subnet mask, gateway, DNS resolver).

network — Whether to enable network connectivity (true or false). netaddress — Connection information, in the format: (iface) {dhcp|static} [(address) (prefix-or-netmask) (gateway)]. For example, netaddress eth0 static 2001:db8::1337 64 2001:db8::1. May be repeated, for multiple interfaces or IPv4/IPv6 dual-homing. nameserver — DNS resolver information. Must be a valid IPv4 or IPv6 address. netssid — Wireless networking information, in the format: (iface) "(SSID)" {none|wep|wpa} [(passphrase)] For example, netssid wlan0 "The New Fox 5G" wpa "shh sekrit". The passphrase may be passed a literal string surrounded by ASCII double-quotes, or a hex string. System behaviour is undefined if the SSID or literal passphrase contain an ASCII double-quote character.

A User needs to specify the timezone the computer will be running in, and the computer's name. The computer's name is used even on non-networked computers, for shell prompts and login screens. The system will also allow the User to ensure the current date and time are accurate.

If the system is running in an installation environment, the system shall display the date and time currently stored in the RTC (Real Time Clock), and allow the User to update the date and time stored in the RTC. The system shall allow the User to choose the time zone to use for time display. The system shall use UTC as the default time zone. The system shall allow the User to input the host name of the computer. The system shall provide a default host name for the User, calculated using the following algorithm: If the system is running in a non-installation environment, use "Adelie" and end calculation. If the system has a manufacturer available via DMI or similar API, use that name truncated to 11 characters. Otherwise, use "Adelie". If the system has a network adaptor installed, even if it is not configured for use, use the last six characters of the MAC address from the first network adaptor. Otherwise, use a random fruit name. The system shall ensure that the host name input by the User uses only valid characters for DNS names, and not accept characters that are invalid. The system shall enable the Next button when the host name field contains a valid name, and disable the Next button when it is empty.

timezone — The zoneinfo name of the system's timezone. Ex: Africa/Nairobi. hostname — The name of the system.

The system will let the User choose what packages and sets of packages to install on their computer.

If the User has chosen to disable the network, the system shall only display presets and packages available for installation locally. The system shall allow the User to choose from one of the following four preset package sets, or to customise the packages installed. The system shall allow the User to choose the Standard preset, which uses adelie-base-posix as an anchor package, and includes the firefox-esr, libreoffice, thunderbird, and vlc packages, and the kde and x11 metapackages. The system shall allow the User to choose the Notebook preset, which includes the Standard preset and additional power management tools (UPower, pm-utils). The system shall allow the User to choose the Minimal preset, which uses adelie-base as an anchor package, and includes the lxqt-desktop, featherpad, netsurf, xorg-apps, xorg-drivers, and xorg-server packages. The system shall allow the User to choose the Minimal Non-Graphical preset, which uses adelie-base as an anchor package, and includes the elinks and tmux packages. The system shall allow the User to choose to customise the packages installed on their computer. The system shall enable the Next button when a selection is made. If the User chooses Custom from UI.Packages.SimpleSel, the system shall present the User with a list of packages and package sets and allow the User to choose any or all of the packages listed. The system shall display the disk space used by each selection, and the total required for installation. The system shall offer at least the following packages, with the following names, descriptions, and corresponding APK package names. Name Description APK name Firefox Web browser The most popular and powerful Web browser for Linux. Includes JavaScript and multimedia (audio/video) playback support. firefox-esr Netsurf Web browser Lightweight Web browser. Does not include JavaScript support. netsurf Thunderbird Email Read and compose email, and participate in newsgroups. thunderbird FeatherPad Lightweight text editor. featherpad LibreOffice Popular, extensible office suite. libreoffice: libreoffice-base, libreoffice-calc, libreoffice-draw, libreoffice-impress, libreoffice-math, libreoffice-writer VLC Media Player Popular multimedia player, including support for a wide variety of audio and video types. vlc KDE Applications A variety of applications including a word processor, media player, and many games. kde KDE Plasma Modern desktop environment with graphical effect support. plasma-desktop LXQt Desktop Environment Lightweight desktop environment using the Openbox window manager and Qt widgets. lxqt-desktop MATE Desktop Environment Traditional desktop environment based on the GNOME 2 look and feel. mate-complete XFCE Desktop Environment Desktop environment based on Gtk+. xfce-desktop Window Managers Individual window managers that are not part of a desktop environment. awesome, fluxbox, i3wm, icewm, openbox, spectrwm If the User has selected a package set or packages that will use more disk space than the computer has, the system shall prompt the User to confirm the selection and warn that installation may not be successful.

pkginstall — A space-separated list of packages to install.

The User needs to configure the administrator password, and provide their name/alias and password for their own account.

The system shall prompt the User to enter a password for the root user. The system shall prompt the User to re-enter the root user password to confirm accuracy. The system shall explain to the User the important of keeping the root user's password secure, and written in a safe place, as it is used for system administration. The system shall enable the Next button when the root password and confirmation match and represent a valid password. If the system is running in an installation environment, then the system shall prompt the User to enter their name or alias to personalise their copy of Adélie Linux. The system shall prompt the User to enter an account name for their user account. The system shall use the following algorithm to provide a default account name for the User: If the User's name or alias contains no spaces, let the account name be the entire name or alias. If the User's name or alias contains spaces, let the account name be the first character of each word that is not the last word, and the full last word. Transform the account name to a Latinised, lower-case form, as described by (Insert Unicode reference here). If the account name is longer than 32 characters, truncate the account name to 32 characters. The system shall allow the User to choose a personal icon to be shown on the system login screen from a list of preset icons. The system shall prompt the User to enter a password for their personal account. The system shall prompt the User to re-enter their personal password to confirm accuracy. The system shall enable the Next button when the user name, account name are valid, and the password and confirm password fields match and represent a valid password.

rootpw — The crypt(3)-formatted, SHA-512 hashed password for the root account. username — The account name for the primary user of the computer. useralias — The primary user's name or alias. userpw — The crypt(3)-formatted, SHA-512 hashed password for the primary user account. usericon — The name of the primary user account's icon.

The User is now able to save the HorizonScript they have created using the Horizon UI. Priority: Medium, since installation environment concerns are paramount for release 1.0.

The system must be running in a runtime environment, not an installation environment.

The system shall inform the User that the system has finished collecting information and is now ready to save the resultant HorizonScript. The system shall replace the "Next" button with a "Save" button using the same keyboard accelerator as Next. When the User chooses "Save", the system shall open a dialogue for the user to navigate to the directory in which they wish to save the HorizonScript, and the name of the file-on disk which shall default to installfile. If the HorizonScript file is saved successfully, the system shall exit. If the HorizonScript file cannot be saved successfully, the system shall display a message indicating the error, and then redisplay the writeout screen.

The system will describe to the User what will be done. The User may confirm, or go back.

The system shall explain to the User that the next step will be performing the installation. If the disk partitioning will cause existing data to be modified or destroyed, the system shall additionally explain to the User that proceeding will modify or destroy the data on the disk(s) partitioned. The system shall display the major choices the User has made in the installation. The choices shown shall be determined later during the UX design phase and are intentionally omitted from this requirements specification. The system shall remove the Cancel button, and the Next button shall be labelled Install.

The system installs Adélie Linux per the User's choices.

If the system is running in a graphical installation environment, the HorizonScript used shall be the HorizonScript generated from the User's choices in the Horizon UI. If the system was booted with a HorizonScript specified, and the graphical progress output option is enabled, the HorizonScript used shall be the HorizonScript loaded from the file or network location specified.

The system shall execute the Horizon Runner with the specified HorizonScript, and display the installation progress. The system shall display no buttons during installation. The system shall update the current step being performed, the progress of the step being performed, and the overall progress of the installation, whenever it receives an update from the Horizon Runner. If the Horizon Runner reports an error, the system shall display a screen explaining the error, possible causes, possible solutions, and that the installation has failed. The system shall allow the User to save the HorizonScript used, along with relevant log files, to a storage location. When Horizon Runner reports that installation is complete, the system shall continue to UI.Finish.

The system informs the User that installation has completed successfully, and allows the User to optionally save the HorizonScript and log files, then remove any media and reboot the computer.

The system shall display a screen congratulating the User on a successful installation of Adélie Linux. The system shall allow the User to save the HorizonScript and log files related to this installation to a storage location. If an error occurs while saving the HorizonScript and log files, the system shall display a message explaining the error, and allow the User to choose a different storage location. The system shall prompt the User to remove any installation media used, including optical media. The system shall only display a single button: Complete, which uses the same keyboard accelerator as the Next button. The Complete button shall cause the system to reboot. If the system is using a HorizonScript loaded from a file or network location, then the system shall automatically reboot the computer in 15 seconds.

The Horizon Runner is the component of Project Horizon that configures a computer to match an input HorizonScript.

The system needs to load the HorizonScript into memory. If the HorizonScript is a local file, the system needs to ensure it is present and readable. If the HorizonScript is remote, the system needs to proceed to Network Configuration before continuing.

The system shall determine if the HorizonScript is stored locally or remotely using the following algorithm: If the path to the HorizonScript is not provided, assume the HorizonScript is remote and end the calculation. Priority: Low. If the path to the HorizonScript begins with a single "/" followed by an alphanumeric character, the HorizonScript is local. If the path to the HorizonScript begins with a recognised valid protocol for downloading a HorizonScript followed by the characters "://", the HorizonScript is remote. If the path to the HorizonScript begins with an alphanumeric character, the HorizonScript is local and relative to the path /etc/horizon. If the path to the HorizonScript does not match any of the rules specified before this line, the path provided is invalid and the system shall return an error describing the specified path and the fact it is invalid. If the HorizonScript is local, the system shall ensure the HorizonScript specified exists at the specified path, is readable by the system, and is the correct format. If the HorizonScript fails the tests in Runner.Locate.Local, the system shall return an error describing the reason the HorizonScript could not be used. If the HorizonScript is remote, the system shall configure the network and then ensure the HorizonScript specified is accessible, as described in the following requirements sections. The system shall use the network settings configured by the Administrator on the command line, if they have been provided. If no network configuration was provided on the command line, the system shall initiate a DHCP request on each available network interface, waiting for a 15 second time out period before continuing to the next network interface. An "available network interface" is defined as a non-loopback network interface that currently has a carrier signal. If no network configuration can be found using DHCP, the system shall return an error describing the inability to configure a network connection. If no HorizonScript path was provided, the system shall download the HorizonScript from a TFTP server using the filename MACADDRESS.installfile where MACADDRESS is the MAC address of the active network adaptor with colons (:) replaced by dashes (-). The system shall use the following algorithm to determine the TFTP server, using the first match. The TFTP server specified in the DHCP options, if the DHCP response provided one. The TFTP server specified on the command line, if one was provided. The DHCP server, if DHCP was used to configure the network. The default gateway IP. The system shall ensure that the server where the HorizonScript is kept is reachable over the protocol specified and that the HorizonScript exists. The system shall download the HorizonScript from the remote server to /etc/horizon/.

The system needs to verify the validity of the supplied HorizonScript before executing it.

The system shall verify the presence and validity of each required keyword in the HorizonScript.