A HorizonScript file is, at its core, a collection of values that determine the actions and configuration values used to transform a computer from an indeterminate state to a well-known state running Adélie Linux. These values are categorised into keys, which is a logical unit of a value. This chapter defines and specifies for every valid key for a HorizonScript file: its name, its purpose, its format, and one or more example values with explanations.

Each key specified in this section is required to be present in a HorizonScript. If any key from this section is missing, the HorizonScript will be considered invalid and Horizon Runner will not execute it.

network The network key determines if the target computer will support networking or not. If the value is true, the computer will support networking, and at least one netaddress key will then be required. The network key is a Boolean value — valid values are true and false. network must appear exactly once in a HorizonScript. network true This enables networking for the target computer.

hostname The hostname key determines the hostname of the target computer. This key is always required, even when the target computer will not participate in a network. The computer's hostname is used on shell prompts, most window manager launchers, and in log files. The hostname key is a string value that must contain only alphanumeric characters and optionally one or more '.' characters. If hostname contains one or more '.' characters, all content before the first '.' is considered the hostname, and all content after the first '.' is considered the domain name. hostname must appear exactly once in a HorizonScript. hostname gwyn This sets the hostname of the target computer to gwyn. hostname gwyn.foxkit.internal This sets the hostname of the target computer to gwyn.foxkit.internal.

Each key specified in this section may be present in a HorizonScript. This section additionally defines the default value or action taken if the specified key is not present.

language The language key determines the default natural language for the target computer. The value of this key will be used to configure the LANG and LC_ALL environment variables, in addition to installing language packs for certain software. The language key is a string value that specifies a valid locale code. A locale code must match one of the following formats: xx, or xx_YY, or xx_YY.UTF-8, where xx is a valid ISO 639-1 language code, and YY is a valid ISO 3166-1 country code. language may appear at most once in a HorizonScript. If the language key is not present, no setting will be defined for the LANG or LC_ALL environment variables. Most software treats this as either "C.UTF-8" or "en_US.UTF-8". No language packs will be installed for software that supports multiple language; due to English being the de facto language of software engineering, this implies all software will run in English. language cy This sets the language of the target computer to Welsh. language fr_CA This sets the language of the target computer to Canadian French.

keymap The keymap key determines the keyboard layout used for input on the target computer. The keymap key is a string value that specifies the name of a keyboard layout. Valid keyboard layouts are listed in /etc/console-setup/ckb/rules/xorg.lst under the ! layout heading. keymap may appear at most once in a HorizonScript. If the keymap key is not present, the target computer will use the default keyboard settings from Linux. These settings are architecture-dependent, but almost universally use a US QWERTY-style layout. keymap fr This sets the keyboard layout of the target computer to French AZERTY.

firmware The firmware key determines if the target computer will load potentially insecure, proprietary firmware. The firmware key is a Boolean value — valid values are true and false. firmware may appear at most once in a HorizonScript. If the firmware key is not present, the target computer will not load proprietary firmware. This is to ensure the integrity, security, and reliability of the target computer. firmware false This explicitly disables loading of firmware on the target computer.

netaddress The netaddress key determines the network configuration used on the target computer. The netaddress key is a space-separated list of network configuration information: The kernel interface name. If the interface specified does not exist, the system will issue a soft error (logging the failure but attempting to continue with installation). The addressing type. Valid values are dhcp for DHCP v4 and v6, slaac for IPv6 Stateless Automatic Address Configuration, and static for Administrator-specified addressing. The list must end here unless the address type specified is static. Any additional items constitute a configuration error and an invalid HorizonScript. The IP address. The value specified must be a valid IPv4 or IPv6 address. The prefix or network mask. The value must be either: A whole number in the range of 1-32 for IPv4 addresses, or 1-64 for IPv6 addresses. An IPv4 network mask, in the format octet.octet.octet.octet. Optionally, the default gateway. The value specified must be a valid IP address of the same family as the IP address specified in item 3. netaddress must not appear unless network is true. If network is true, then netaddress must appear at least once, and may appear up to 255 times per interface. There is no default for this key. It is invalid to enable networking and not provide at least one netaddress key. netaddress eth0 dhcp This configures the target computer to use DHCP on interface eth0. netaddress eth0 2001:db8::1337 64 2001:db8::1 netaddress eth0 198.51.100.37 24 198.51.100.1 This configures the target computer to use the addresses 2001:db::1337/64 and 198.51.100.37/24 on interface eth0. The default gateways are 2001:db::1 and 198.51.100.1.

nameserver The nameserver key determines the DNS server used for name queries on the target computer. The nameserver key takes either an IPv4 address or IPv6 address. Any other value is invalid. The nameserver may appear up to four times in a HorizonScript, or be omitted. It is valid to specify nameserver even if network is false, but name queries will not function properly without a network configuration. If the nameserver key is not specified, name queries requiring the DNS will not succeed on the target computer. nameserver 2620:fe::fe This configures the target computer to use Quad9's public resolver, 2620:fe::fe, for name queries.

netssid The netssid key determines the wireless networking configuration on the target computer. The netssid is a space-separated list of wireless networking configuration information: The kernel interface name. If the interface specified does not exist, the system will issue a soft error (logging the failure but attempting to continue with installation). The SSID name to connect to. This must be a string value enclosed by ASCII double-quotes ("). System behaviour is undefined if the SSID name contains an ASCII double-quote. The security type of the SSID. Valid values are none for an open access point, wep for a WEP passphrase, and wpa for a WPA pre-shared key (PSK). If the security type is not none, the passphrase or pre-shared key. WPA PSKs may be specified in hexadecimal or as a raw string. The remainder of the line will be used verbatim. If the netssid key is not specified, no wireless network configuration will be present on the target computer. netssid wlan0 "h" none This configures the target computer to connect to the access point with name h, with no security. netssid wlan0 "Hophop" wep omgitsarabbit This configures the target computer to connect to the access point with name Hophop, with the WEP passphrase omgitsarabbit. netssid wlan0 "The New Fox 5G" wpa shh sekrit This configures the target computer to connect to the access point with name The New Fox 5G, with the WPA PSK shh sekrit.