Merge pull request #516 from l4zy0n3/master
Incorporated some suggestions, some keys added in help table for config
This commit is contained in:
commit
3bf12ffe1e
|
|
@ -39,7 +39,7 @@ And to run it, execute archinstall as a Python module:
|
||||||
| The ``--script guided`` argument is optional as it's the default behavior.
|
| The ``--script guided`` argument is optional as it's the default behavior.
|
||||||
| But this will start the process of guiding you through a installation of a quite minimal Arch Linux experience.
|
| But this will start the process of guiding you through a installation of a quite minimal Arch Linux experience.
|
||||||
|
|
||||||
Installing directly from a config file
|
Installing directly from a configuration file
|
||||||
--------------------------------------
|
--------------------------------------
|
||||||
|
|
||||||
.. note::
|
.. note::
|
||||||
|
|
@ -58,6 +58,7 @@ Installing directly from a config file
|
||||||
],
|
],
|
||||||
"!encryption-password": "supersecret",
|
"!encryption-password": "supersecret",
|
||||||
"filesystem": "btrfs",
|
"filesystem": "btrfs",
|
||||||
|
"gfx_driver": "VMware / VirtualBox (open-source)",
|
||||||
"harddrive": {
|
"harddrive": {
|
||||||
"path": "/dev/nvme0n1"
|
"path": "/dev/nvme0n1"
|
||||||
},
|
},
|
||||||
|
|
@ -66,14 +67,11 @@ Installing directly from a config file
|
||||||
"linux"
|
"linux"
|
||||||
],
|
],
|
||||||
"keyboard-language": "us",
|
"keyboard-language": "us",
|
||||||
"mirror-region": {
|
"mirror-region": "Worldwide",
|
||||||
"Worldwide": {
|
|
||||||
"https://mirror.rackspace.com/archlinux/$repo/os/$arch": true
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"nic": {
|
"nic": {
|
||||||
"NetworkManager": true
|
"NetworkManager": true
|
||||||
},
|
},
|
||||||
|
"ntp": true,
|
||||||
"packages": ["docker", "git", "wget", "zsh"],
|
"packages": ["docker", "git", "wget", "zsh"],
|
||||||
"profile": "gnome",
|
"profile": "gnome",
|
||||||
"services": ["docker"],
|
"services": ["docker"],
|
||||||
|
|
@ -82,6 +80,8 @@ Installing directly from a config file
|
||||||
"!password": "devel"
|
"!password": "devel"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
|
"sys-encoding": "utf-8",
|
||||||
|
"sys-language": "en_US",
|
||||||
"timezone": "US/Eastern",
|
"timezone": "US/Eastern",
|
||||||
"users": {}
|
"users": {}
|
||||||
}
|
}
|
||||||
|
|
@ -92,46 +92,55 @@ To run it, execute archinstall as a Python module:
|
||||||
|
|
||||||
python -m archinstall --config <local path or remote URL>
|
python -m archinstall --config <local path or remote URL>
|
||||||
|
|
||||||
+----------------------+--------------------------------------------------------+----------------------------------------------------------------------------+-----------------------------------------------+
|
+----------------------+--------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------+-----------------------------------------------+
|
||||||
| Key | Values/Description | Description | Required |
|
| Key | Values/Description | Description | Required |
|
||||||
| | | | |
|
| | | | |
|
||||||
+======================+========================================================+============================================================================+===============================================+
|
+======================+======================================================================================================================================+======================================================================================+===============================================+
|
||||||
| audio | pipewire/pulseaudio | Audioserver to be installed | No |
|
| audio | pipewire/pulseaudio | Audioserver to be installed | No |
|
||||||
+----------------------+--------------------------------------------------------+----------------------------------------------------------------------------+-----------------------------------------------+
|
+----------------------+--------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------+-----------------------------------------------+
|
||||||
| bootloader | systemd-bootctl/grub-install | Bootloader to be installed | Yes |
|
| bootloader | systemd-bootctl/grub-install | Bootloader to be installed | Yes |
|
||||||
+----------------------+--------------------------------------------------------+----------------------------------------------------------------------------+-----------------------------------------------+
|
+----------------------+--------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------+-----------------------------------------------+
|
||||||
| custom-commands | [ <command1>, <command2>, ...] | Custom commands to be run post install | No |
|
| 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 |
|
| !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 |
|
| filesystem | ext4 / btrfs / fat32 etc. | Filesystem for root and home partitions | Yes |
|
||||||
+----------------------+--------------------------------------------------------+----------------------------------------------------------------------------+-----------------------------------------------+
|
+----------------------+--------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------+-----------------------------------------------+
|
||||||
| harddrive | { "path": <path of device> } | Path of device to be used | 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 |
|
||||||
+----------------------+--------------------------------------------------------+----------------------------------------------------------------------------+-----------------------------------------------+
|
| | | | |
|
||||||
| hostname | any | Hostname of machine after installation | Yes |
|
+----------------------+--------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------+-----------------------------------------------+
|
||||||
+----------------------+--------------------------------------------------------+----------------------------------------------------------------------------+-----------------------------------------------+
|
| harddrive | { "path": <path of device> } | Path of device to be used | Yes |
|
||||||
| kernels | [ "kernel1", "kernel2"] | List of kernels to install eg: linux, linux-lts, linux-zen etc | Atleast 1 |
|
+----------------------+--------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------+-----------------------------------------------+
|
||||||
+----------------------+--------------------------------------------------------+----------------------------------------------------------------------------+-----------------------------------------------+
|
| hostname | any | Hostname of machine after installation | Yes |
|
||||||
| keyboard-language | 2 letter code for your keyboard language | eg: us, de etc | Yes |
|
+----------------------+--------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------+-----------------------------------------------+
|
||||||
+----------------------+--------------------------------------------------------+----------------------------------------------------------------------------+-----------------------------------------------+
|
| kernels | [ "kernel1", "kernel2"] | List of kernels to install eg: linux, linux-lts, linux-zen etc | Atleast 1 |
|
||||||
| mirror-region | {"<Region Name>": { "Mirror Name": True/False}, ..} | List of regions and mirrors to use | Yes |
|
+----------------------+--------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------+-----------------------------------------------+
|
||||||
+----------------------+--------------------------------------------------------+----------------------------------------------------------------------------+-----------------------------------------------+
|
| keyboard-language | 2 letter code for your keyboard language | eg: us, de etc | Yes |
|
||||||
| nic | nic to use, Use value NetworkManager for installing it | | Yes |
|
+----------------------+--------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------+-----------------------------------------------+
|
||||||
+----------------------+--------------------------------------------------------+----------------------------------------------------------------------------+-----------------------------------------------+
|
| mirror-region | {"<Region Name>": { "Mirror Name": True/False}, ..} | List of regions and mirrors to use | Yes |
|
||||||
| packages | [ "package1", "package2", ..] | List of packages to install post-installation | No |
|
+----------------------+--------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------+-----------------------------------------------+
|
||||||
+----------------------+--------------------------------------------------------+----------------------------------------------------------------------------+-----------------------------------------------+
|
| nic | { NetworkManager: <boolean>, nic: <nic name> } | | Yes |
|
||||||
| profile | Name of profile to install | profiles are present in profiles/, use the name of a profile to install it | No |
|
+----------------------+--------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------+-----------------------------------------------+
|
||||||
+----------------------+--------------------------------------------------------+----------------------------------------------------------------------------+-----------------------------------------------+
|
| ntp | <boolean> | Set to true to set-up ntp post install | No |
|
||||||
| !root-password | any | The root account password | No |
|
+----------------------+--------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------+-----------------------------------------------+
|
||||||
+----------------------+--------------------------------------------------------+----------------------------------------------------------------------------+-----------------------------------------------+
|
| packages | [ "package1", "package2", ..] | List of packages to install post-installation | No |
|
||||||
| services | [ "service1", "service2", ..] | Services to enable post-installation | No |
|
+----------------------+--------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------+-----------------------------------------------+
|
||||||
+----------------------+--------------------------------------------------------+----------------------------------------------------------------------------+-----------------------------------------------+
|
| profile | Name of the profile to install | Profiles are present in profiles/, use the name of a profile to install it | No |
|
||||||
| superusers | { "<username>": { "!password": "<password>"}, ..} | List of superuser credentials, see config for reference | Yes, if root account password is not provided |
|
+----------------------+--------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------+-----------------------------------------------+
|
||||||
+----------------------+--------------------------------------------------------+----------------------------------------------------------------------------+-----------------------------------------------+
|
| !root-password | any | The root account password | No |
|
||||||
| timezone | Timezone to configure in installation | Timezone eg: UTC, Asia/Kolkata etc. | Yes |
|
+----------------------+--------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------+-----------------------------------------------+
|
||||||
+----------------------+--------------------------------------------------------+----------------------------------------------------------------------------+-----------------------------------------------+
|
| services | [ "service1", "service2", ..] | Services to enable post-installation | No |
|
||||||
| users | { "<username>": { "!password": "<password>"}, ..} | List of regular user credentials, see config for reference | Yes, can be {} |
|
+----------------------+--------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------+-----------------------------------------------+
|
||||||
+----------------------+--------------------------------------------------------+----------------------------------------------------------------------------+-----------------------------------------------+
|
| 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 configuration 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 configuration for reference | Yes, can be {} |
|
||||||
|
+----------------------+--------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------+-----------------------------------------------+
|
||||||
|
|
||||||
Description individual steps
|
Description individual steps
|
||||||
============================
|
============================
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue