merged with upstreamHEADmaster

5 files changed, 304 insertions, 0 deletions

diff --git a/docs/cli_parameters/config/config_options.csv b/docs/cli_parameters/config/config_options.csv
new file mode 100644
index 00000000..7cf10982
--- /dev/null
+++ b/docs/cli_parameters/config/config_options.csv
@@ -0,0 +1,24 @@
+Key,Value(s),Description,Required
+additional-repositories,[ `multilib <https://wiki.archlinux.org/title/Official_repositories#multilib>`_!, `testing <https://wiki.archlinux.org/title/Official_repositories#Testing_repositories>`_ ],Enables one or more of the testing and multilib repositories before proceeding with installation,No
+archinstall-language,`lang <https://github.com/archlinux/archinstall/blob/master/archinstall/locales/languages.json>`__,Sets the TUI language used *(make sure to use the ``lang`` value not the ``abbr``)*,No
+audio_config,`pipewire <https://wiki.archlinux.org/title/PipeWire>`_!, `pulseaudio <https://wiki.archlinux.org/title/PulseAudio>`_,Audioserver to be installed,No
+bootloader,`Systemd-boot <https://wiki.archlinux.org/title/Systemd-boot>`_!, `grub <https://wiki.archlinux.org/title/GRUB>`_,Bootloader to be installed *(grub being mandatory on BIOS machines)*,Yes
+debug,``true``!, ``false``,Enables debug output,No
+disk_config,*Read more under* :ref:`disk config`,Contains the desired disk setup to be used during installation,No
+disk_encryption,*Read more about under* :ref:`disk encryption`,Parameters for disk encryption applied on top of ``disk_config``,No
+hostname,``str``,A string defining your machines hostname on the network *(defaults to ``archinstall``)*,No
+kernels,[ `linux <https://wiki.archlinux.org/title/Kernel#Officially_supported_kernels>`_!, `linux-hardened <https://wiki.archlinux.org/title/Kernel#Officially_supported_kernels>`_!, `linux-lts <https://wiki.archlinux.org/title/Kernel#Officially_supported_kernels>`_!, `linux-rt <https://wiki.archlinux.org/title/Kernel#Officially_supported_kernels>`_!, `linux-rt-lts <https://wiki.archlinux.org/title/Kernel#Officially_supported_kernels>`_!, `linux-zen <https://wiki.archlinux.org/title/Kernel#Officially_supported_kernels>`_ ],Defines which kernels should be installed and setup in the boot loader options,Yes
+custom-commands,*Read more under* :ref:`custom commands`,Custom commands that will be run post-install chrooted inside the installed system,No
+locale_config,{kb_layout: `lang <https://wiki.archlinux.org/title/Linux_console/Keyboard_configuration>`__!, sys_enc: `Character encoding <https://wiki.archlinux.org/title/Locale>`_!, sys_lang: `locale <https://wiki.archlinux.org/title/Locale>`_},Defines the keyboard key map!, system encoding and system locale,No
+mirror_config,{custom_mirrors: [ https://... ]!, mirror_regions: { "Worldwide": [ "https://geo.mirror.pkgbuild.com/$repo/os/$arch" ] } },Sets various mirrors *(defaults to ISO's ``/etc/pacman.d/mirrors`` if not defined)*,No
+network_config,*`see options under Network Configuration`*,Sets which type of *(if any)* network configuration should be used,No
+no_pkg_lookups,``true``!, ``false``,Disabled package checking against https://archlinux.org/packages/,No
+ntp,``true``!, ``false``,enables or disables `NTP <https://wiki.archlinux.org/title/Network_Time_Protocol_daemon>`_ during installation,No
+offline,``true``!, ``false``,enables or disables certain online checks such as mirror reachability etc,No
+packages,[ <package1>!, <package2>!, ... ],A list of packages to install during installation,No
+parallel downloads,0-∞,sets a given number of parallel downloads to be used by `pacman <https://wiki.archlinux.org/title/Pacman#Enabling_parallel_downloads>`_,No
+profile_config,*`read more under the profiles section`*,Installs a given profile if defined,No
+script,`guided <https://github.com/archlinux/archinstall/blob/master/archinstall/scripts/guided.py>`__! *(default)*!, `minimal <https://github.com/archlinux/archinstall/blob/master/archinstall/scripts/minimal.py>`__!, `only_hdd <https://github.com/archlinux/archinstall/blob/master/archinstall/scripts/only_hdd.py>`_!, `swiss <https://github.com/archlinux/archinstall/blob/master/archinstall/scripts/swiss.py>`_!, `unattended <https://github.com/archlinux/archinstall/blob/master/archinstall/scripts/unattended.py>`_,When used to autorun an installation!, this sets which script to autorun with,No
+silent,``true``!, ``false``,disables or enables user questions using the TUI,No
+swap,``true``!, ``false``,enables or disables swap,No
+timezone,`timezone <https://wiki.archlinux.org/title/System_time#Time_zone>`_,sets a timezone for the installed system,No
diff --git a/docs/cli_parameters/config/custom_commands.rst b/docs/cli_parameters/config/custom_commands.rst
new file mode 100644
index 00000000..c1529020
--- /dev/null
+++ b/docs/cli_parameters/config/custom_commands.rst
@@ -0,0 +1,22 @@
+.. _custom commands:
+
+Custom Commands
+===============
+
+| Custom commands is a configuration entry that allows for executing custom commands post-installation.
+| The commands are executed with `arch-chroot <https://man.archlinux.org/man/extra/arch-install-scripts/arch-chroot.8.en>`_.
+
+The option takes a list of arguments, an example is:
+
+.. code-block:: json
+
+   {
+       "custom-commands": [
+           "hostname new-hostname"
+       ]
+   }
+
+| The following example will set a new hostname in the installed system.
+| The example is just to illustrate that the command is not run in the ISO but inside the installed system after the base system is installed.
+
+More examples can be found in the code repository under `examples/ <https://github.com/archlinux/archinstall/tree/e6344f93f7e476d05bbcd642f2ed91fdde545870/examples>`_
\ No newline at end of file
diff --git a/docs/cli_parameters/config/disk_config.rst b/docs/cli_parameters/config/disk_config.rst
new file mode 100644
index 00000000..b09d0dc0
--- /dev/null
+++ b/docs/cli_parameters/config/disk_config.rst
@@ -0,0 +1,235 @@
+.. _disk config:
+
+Disk Configuration
+==================
+
+There are only three modes in the ``disk_config`` option. They are described in more detail below.
+
+"Leave as is"
+--------------
+
+.. code-block:: json
+
+   {
+       "config_type": "pre_mounted_config",
+       "mountpoint": "/mnt/archinstall"
+   }
+
+This mode will not perform any partitioning what so ever.
+Instead it relies on what's mounted manually by the user under ``/mnt/archinstall``.
+
+Given the following disk example:
+
+.. code-block::
+
+   /mnt/archinstall    (/dev/sda2)
+        ├── boot       (/dev/sda1)
+        └── home       (/dev/sda3)
+
+Running ``archinstall --conf your.json --silent`` where the above JSON is configured. The disk will be left alone — and a working system will be installed to the above folders and mountpoints will be translated into the installed system.
+
+.. note::
+
+   Some disk layouts can be too complicated to detect, such as RAID setups. Please do report those setups on the `Issue Tracker <https://github.com/archlinux/archinstall>`__ so we can support them.
+
+Best Effort
+-----------
+
+.. warning::
+
+   This mode will wipe data!
+
+.. note::
+
+   Note that this options is similar to the manual partitioning but is generated through the menu system! And the best effort layout might deviate slightly from some wiki guidelines in order to facilitate some optional configurations at a later stage.
+
+.. code-block:: json
+
+   {
+       "disk_config": {
+           "config_type": "default_layout",
+           "device_modifications": [
+               {
+                   "device": "/dev/sda",
+                   "wipe": true,
+                   "partitions": "..."
+               }
+           ]
+       }
+   }
+
+This mode will attempt to configure a sane default layout on the selected disks.
+Based on the chosen filesystem, and potential optional settings for said filesystem — different default layouts will be provided.
+
+Manual Partitioning
+-------------------
+
+.. code-block:: json
+
+   {
+        "disk_config": {
+            "config_type": "manual_partitioning",
+            "device_modifications": [
+               "filesystem struct"
+            ]
+        }
+    }
+
+Manual partitioning is the most complex one of the three. It offers you near endless flexibility of how to partition your disk. It integrates against `pyparted <https://github.com/dcantrell/pyparted>`__ and some control logic in ``archinstall`` that deals with creating things like subvolumes and compression.
+
+Sizes are by default ``sector`` units, but other units are supported.
+
+The options supplied to ``manual_partitioning`` are dictionary definitions, where the following parameters must exist:
+
+.. csv-table:: JSON options
+   :file: ./manual_options.csv
+   :widths: 15, 15, 65, 5
+   :escape: !
+   :header-rows: 1
+
+Each partition definition heavily relies on what filesystem is used.
+Below follow two of the more common filesystems, anything else will best be described by running ``archinstall`` to generate a desired configuration for the desired filesystem type — and copy the relevant parts for permanent configurations.
+
+.. warning::
+
+   Important to note that the units and positions in the examples below — are highly user specific!
+
+FAT32
+^^^^^
+
+.. code-block:: json
+
+	{
+		"btrfs": [],
+		"flags": [
+		   "Boot"
+		],
+		"fs_type": "fat32",
+		"length": {
+		   "sector_size": null,
+		   "total_size": null,
+		   "unit": "B",
+		   "value": 99982592
+		},
+		"mount_options": [],
+		"mountpoint": "/boot",
+		"obj_id": "369f31a8-2781-4d6b-96e7-75680552b7c9",
+		"start": {
+		   "sector_size": {
+		       "sector_size": null,
+		       "total_size": null,
+		       "unit": "B",
+		       "value": 512
+		   },
+		   "total_size": null,
+		   "unit": "sectors",
+		   "value": 34
+		},
+		"status": "create",
+		"type": "primary"
+	}
+
+.. note::
+
+   The ``Boot`` flag will make ``archinstall`` automatically set the correct ESP partition GUID if the system is booted with ``EFI`` support. The GUID will then be set to ``C12A7328-F81F-11D2-BA4B-00A0C93EC93B``.
+
+EXT4
+^^^^
+
+.. code-block:: json
+
+	{
+      "btrfs": [],
+      "flags": [],
+      "fs_type": "ext4",
+      "length": {
+         "sector_size": null,
+         "total_size": null,
+         "unit": "B",
+         "value": 15805127360
+      },
+      "mount_options": [],
+      "mountpoint": "/",
+      "obj_id": "3e75d045-21a4-429d-897e-8ec19a006e8b",
+      "start": {
+         "sector_size": {
+            "sector_size": null,
+            "total_size": null,
+            "unit": "B",
+            "value": 512
+         },
+         "total_size": {
+            "sector_size": null,
+            "total_size": null,
+            "unit": "B",
+            "value": 16106127360
+         },
+         "unit": "MB",
+         "value": 301
+      },
+      "status": "create",
+      "type": "primary"
+   }
+
+BTRFS
+^^^^^
+
+The BTRFS filesystem is inherently more complicated, thus the options are a bit more involved.
+This example contains both subvolumes and compression.
+
+.. note::
+
+   Note that the ``"mountpoint": null`` is used for the overall partition, and instead individual subvolumes have mountpoints set.
+
+.. code-block:: json
+
+   {
+      "btrfs": [
+          {
+              "mountpoint": "/",
+              "name": "@",
+          },
+          {
+              "mountpoint": "/home",
+              "name": "@home",
+          },
+          {
+              "mountpoint": "/var/log",
+              "name": "@log",
+          },
+          {
+              "mountpoint": "/var/cache/pacman/pkg",
+              "name": "@pkg",
+          },
+          {
+              "mountpoint": "/.snapshots",
+              "name": "@.snapshots",
+          }
+      ],
+      "dev_path": null,
+      "flags": [],
+      "fs_type": "btrfs",
+      "mount_options": [
+          "compress=zstd"
+      ],
+      "mountpoint": null,
+      "obj_id": "d712357f-97cc-40f8-a095-24ff244d4539",
+      "size": {
+          "sector_size": {
+              "unit": "B",
+              "value": 512
+          },
+          "unit": "B",
+          "value": 15568207872
+      },
+      "start": {
+          "sector_size": {
+              "unit": "B",
+              "value": 512
+          },
+          "unit": "MiB",
+          "value": 513
+      },
+      "status": "create",
+      "type": "primary"
+   }
diff --git a/docs/cli_parameters/config/disk_encryption.rst b/docs/cli_parameters/config/disk_encryption.rst
new file mode 100644
index 00000000..df2e2fa7
--- /dev/null
+++ b/docs/cli_parameters/config/disk_encryption.rst
@@ -0,0 +1,19 @@
+.. _disk encryption:
+
+Disk Encryption
+===============
+
+Disk encryption consists of a top level entry in the user configuration.
+
+.. code-block:: json
+
+   {
+        "disk_encryption": {
+            "encryption_type": "luks",
+            "partitions": [
+                "d712357f-97cc-40f8-a095-24ff244d4539"
+            ]
+        }
+   }
+
+The ``UID`` in the ``partitions`` list is an internal reference to the ``obj_id`` in the :ref:`disk config` entries.
\ No newline at end of file
diff --git a/docs/cli_parameters/config/manual_options.csv b/docs/cli_parameters/config/manual_options.csv
new file mode 100644
index 00000000..2fcc26f0
--- /dev/null
+++ b/docs/cli_parameters/config/manual_options.csv
@@ -0,0 +1,4 @@
+Key,Value(s),Description,Required
+device,``str``,Which block-device to format,yes
+partitions,[ {key: val} ],The data describing the change/addition in a partition,yes
+wipe,``bool``,clear the disk before adding any partitions,No
\ No newline at end of file