HorizonScript Specification

A. Wilcox

Adélie Linux

Development documentation for Project Horizon is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License.

You should have received a copy of the license along with this work. If not, see the Creative Commons Web site.

2019

Abstract

This document describes the file format of HorizonScript. HorizonScript is the input file used for Project Horizon, the installation system for Adélie Linux.


Table of Contents

1. Introduction
Purpose
Document Conventions
Intended Audience
2. HorizonScript Keys
Introduction
Required Keys
network
hostname
pkginstall
rootpw
Optional Keys
language
keymap
firmware
netaddress
nameserver
netssid
timezone
repository
signingkey
username
useralias
userpw
usericon
usergroups
Disk Partitioning Keys
Sizing
diskid
disklabel
partition
lvm_pv
lvm_vg
lvm_lv
encrypt
fs
mount
3. On-Disk Format

List of Examples

2.1. The network Key
2.2. The hostname Key — Setting a Host Name
2.3. The hostname Key — Setting a Host Name and Domain Name
2.4. The pkginstall Key — Simple Usage
2.5. The pkginstall Key — Multiple Invocations
2.6. The rootpw Key
2.7. The language Key — Simple Language
2.8. The language Key — Language with Country Localisation
2.9. The keymap Key
2.10. The firmware Key
2.11. The netaddress Key — Simple DHCP
2.12. The netaddress Key — Static Addressing
2.13. The nameserver Key
2.14. The netssid Key — Open Network
2.15. The netssid Key — WEP Network
2.16. The netssid Key — WPA2 Network
2.17. The timezone Key
2.18. The repository Key
2.19. The signingkey Key
2.20. The username Key — Simple Usage
2.21. The username Key — Advanced Usage
2.22. The useralias Key
2.23. The userpw Key
2.24. The usericon Key
2.25. The usergroups Key — Simple Usage
2.26. The usergroups Key — Advanced Usage
2.27. The diskid Key — Verify Manufacturer of Hard Disk
2.28. The diskid Key — Verify Model of NVMe Device
2.29. The disklabel Key — Simple Usage
2.30. The disklabel Key — Multiple Disks
2.31. The partition Key — Simple Usage
2.32. The partition Key — Advanced Usage
2.33. The lvm_pv Key — Whole Disk LVM
2.34. The lvm_pv Key — LVM Partition
2.35. The lvm_vg Key
2.36. The lvm_lv Key
2.37. The encrypt Key — Prompt for Passphrase
2.38. The encrypt Key — Use Plaintext Passphrase
2.39. The fs Key
2.40. The mount Key