Send patches - preferably formatted by git format-patch - to patches at archlinux32 dot org.
summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/installing/guided.rst89
1 files changed, 49 insertions, 40 deletions
diff --git a/docs/installing/guided.rst b/docs/installing/guided.rst
index e442d927..58e3cb6c 100644
--- a/docs/installing/guided.rst
+++ b/docs/installing/guided.rst
@@ -92,46 +92,55 @@ To run it, execute archinstall as a Python module:
python -m archinstall --config <local path or remote URL>
-+----------------------+--------------------------------------------------------+----------------------------------------------------------------------------+-----------------------------------------------+
-| Key | Values/Description | Description | Required |
-| | | | |
-+======================+========================================================+============================================================================+===============================================+
-| audio | pipewire/pulseaudio | Audioserver to be installed | No |
-+----------------------+--------------------------------------------------------+----------------------------------------------------------------------------+-----------------------------------------------+
-| bootloader | systemd-bootctl/grub-install | Bootloader to be installed | Yes |
-+----------------------+--------------------------------------------------------+----------------------------------------------------------------------------+-----------------------------------------------+
-| custom-commands | [ <command1>, <command2>, ...] | Custom commands to be run post install | No |
-+----------------------+--------------------------------------------------------+----------------------------------------------------------------------------+-----------------------------------------------+
-| !encryption-password | any | Password to encrypt disk, not encrypted if password not provided | No |
-+----------------------+--------------------------------------------------------+----------------------------------------------------------------------------+-----------------------------------------------+
-| filesystem | ext4 / btrfs / fat32 etc. | Filesystem for root and home partitions | Yes |
-+----------------------+--------------------------------------------------------+----------------------------------------------------------------------------+-----------------------------------------------+
-| harddrive | { "path": <path of device> } | Path of device to be used | Yes |
-+----------------------+--------------------------------------------------------+----------------------------------------------------------------------------+-----------------------------------------------+
-| hostname | any | Hostname of machine after installation | Yes |
-+----------------------+--------------------------------------------------------+----------------------------------------------------------------------------+-----------------------------------------------+
-| kernels | [ "kernel1", "kernel2"] | List of kernels to install eg: linux, linux-lts, linux-zen etc | Atleast 1 |
-+----------------------+--------------------------------------------------------+----------------------------------------------------------------------------+-----------------------------------------------+
-| keyboard-language | 2 letter code for your keyboard language | eg: us, de etc | Yes |
-+----------------------+--------------------------------------------------------+----------------------------------------------------------------------------+-----------------------------------------------+
-| mirror-region | {"<Region Name>": { "Mirror Name": True/False}, ..} | List of regions and mirrors to use | Yes |
-+----------------------+--------------------------------------------------------+----------------------------------------------------------------------------+-----------------------------------------------+
-| nic | nic to use, Use value NetworkManager for installing it | | Yes |
-+----------------------+--------------------------------------------------------+----------------------------------------------------------------------------+-----------------------------------------------+
-| packages | [ "package1", "package2", ..] | List of packages to install post-installation | No |
-+----------------------+--------------------------------------------------------+----------------------------------------------------------------------------+-----------------------------------------------+
-| profile | Name of profile to install | profiles are present in profiles/, use the name of a profile to install it | No |
-+----------------------+--------------------------------------------------------+----------------------------------------------------------------------------+-----------------------------------------------+
-| !root-password | any | The root account password | No |
-+----------------------+--------------------------------------------------------+----------------------------------------------------------------------------+-----------------------------------------------+
-| services | [ "service1", "service2", ..] | Services to enable post-installation | No |
-+----------------------+--------------------------------------------------------+----------------------------------------------------------------------------+-----------------------------------------------+
-| superusers | { "<username>": { "!password": "<password>"}, ..} | List of superuser credentials, see config for reference | Yes, if root account password is not provided |
-+----------------------+--------------------------------------------------------+----------------------------------------------------------------------------+-----------------------------------------------+
-| timezone | Timezone to configure in installation | Timezone eg: UTC, Asia/Kolkata etc. | Yes |
-+----------------------+--------------------------------------------------------+----------------------------------------------------------------------------+-----------------------------------------------+
-| users | { "<username>": { "!password": "<password>"}, ..} | List of regular user credentials, see config for reference | Yes, can be {} |
-+----------------------+--------------------------------------------------------+----------------------------------------------------------------------------+-----------------------------------------------+
++----------------------+--------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------+-----------------------------------------------+
+| Key | Values/Description | Description | Required |
+| | | | |
++======================+======================================================================================================================================+======================================================================================+===============================================+
+| audio | pipewire/pulseaudio | Audioserver to be installed | No |
++----------------------+--------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------+-----------------------------------------------+
+| bootloader | systemd-bootctl/grub-install | Bootloader to be installed | Yes |
++----------------------+--------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------+-----------------------------------------------+
+| custom-commands | [ <command1>, <command2>, ...] | Custom commands to be run post install | No |
++----------------------+--------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------+-----------------------------------------------+
+| !encryption-password | any | Password to encrypt disk, not encrypted if password not provided | No |
++----------------------+--------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------+-----------------------------------------------+
+| filesystem | ext4 / btrfs / fat32 etc. | Filesystem for root and home partitions | Yes |
++----------------------+--------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------+-----------------------------------------------+
+| gfx_driver | "VMware / VirtualBox (open-source)" or "Nvidia" or "Intel (open-source)" or "AMD / ATI (open-source)" or "All open-source (default)" | Graphics Drivers to install | No |
+| | | | |
++----------------------+--------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------+-----------------------------------------------+
+| harddrive | { "path": <path of device> } | Path of device to be used | Yes |
++----------------------+--------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------+-----------------------------------------------+
+| hostname | any | Hostname of machine after installation | Yes |
++----------------------+--------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------+-----------------------------------------------+
+| kernels | [ "kernel1", "kernel2"] | List of kernels to install eg: linux, linux-lts, linux-zen etc | Atleast 1 |
++----------------------+--------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------+-----------------------------------------------+
+| keyboard-language | 2 letter code for your keyboard language | eg: us, de etc | Yes |
++----------------------+--------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------+-----------------------------------------------+
+| mirror-region | {"<Region Name>": { "Mirror Name": True/False}, ..} | List of regions and mirrors to use | Yes |
++----------------------+--------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------+-----------------------------------------------+
+| nic | { NetworkManager: <boolean>, nic: <nic name> } | | Yes |
++----------------------+--------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------+-----------------------------------------------+
+| ntp | <boolean> | Set to true to set-up ntp post install | No |
++----------------------+--------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------+-----------------------------------------------+
+| packages | [ "package1", "package2", ..] | List of packages to install post-installation | No |
++----------------------+--------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------+-----------------------------------------------+
+| profile | Name of profile to install | profiles are present in profiles/, use the name of a profile to install it | No |
++----------------------+--------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------+-----------------------------------------------+
+| !root-password | any | The root account password | No |
++----------------------+--------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------+-----------------------------------------------+
+| services | [ "service1", "service2", ..] | Services to enable post-installation | No |
++----------------------+--------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------+-----------------------------------------------+
+| sys-encoding | "utf-8" | Set to change system encoding post-install, ignored if --advanced flag is not passed | No |
++----------------------+--------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------+-----------------------------------------------+
+| sys-language | "en_US" | Set to change system language post-install, ignored if --advanced flag is not passed | No |
++----------------------+--------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------+-----------------------------------------------+
+| superusers | { "<username>": { "!password": "<password>"}, ..} | List of superuser credentials, see config for reference | Yes, if root account password is not provided |
++----------------------+--------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------+-----------------------------------------------+
+| timezone | Timezone to configure in installation | Timezone eg: UTC, Asia/Kolkata etc. | Yes |
++----------------------+--------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------+-----------------------------------------------+
+| users | { "<username>": { "!password": "<password>"}, ..} | List of regular user credentials, see config for reference | Yes, can be {} |
++----------------------+--------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------+-----------------------------------------------+
Description individual steps
============================