Send patches - preferably formatted by git format-patch - to patches at archlinux32 dot org.
summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorAnton Hvornum <anton@hvornum.se>2021-06-04 15:07:42 +0200
committerAnton Hvornum <anton@hvornum.se>2021-06-04 15:07:42 +0200
commit7d60287a3d24303a4e4518b75058ffd2f1feca8d (patch)
treea641fa6ea284ff677b549f00c471dcdd1f501dc3 /docs
parent515cd4daf01d1239843530093bdae876f4d7f841 (diff)
parent7a40f1dc0bf130847e7deba55f11cb0b7319d6a2 (diff)
Merged in changes from master
Diffstat (limited to 'docs')
-rw-r--r--docs/index.rst3
-rw-r--r--docs/installing/guided.rst101
2 files changed, 55 insertions, 49 deletions
diff --git a/docs/index.rst b/docs/index.rst
index a5d07901..0d80501b 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -6,9 +6,6 @@ python-archinstall Documentation
|
| A demo can be viewed here: `https://www.youtube.com/watch?v=9Xt7X_Iqg6E <https://www.youtube.com/watch?v=9Xt7X_Iqg6E>`_ which uses the default guided installer.
-.. warning::
- This installer currently requires that your machine has EFI-mode enabled.
-
Some of the features of Archinstall are:
* **No external dependencies or installation requirements.** Runs without any external requirements or installation processes.
diff --git a/docs/installing/guided.rst b/docs/installing/guided.rst
index e442d927..03225adb 100644
--- a/docs/installing/guided.rst
+++ b/docs/installing/guided.rst
@@ -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.
| 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::
@@ -58,6 +58,7 @@ Installing directly from a config file
],
"!encryption-password": "supersecret",
"filesystem": "btrfs",
+ "gfx_driver": "VMware / VirtualBox (open-source)",
"harddrive": {
"path": "/dev/nvme0n1"
},
@@ -66,14 +67,11 @@ Installing directly from a config file
"linux"
],
"keyboard-language": "us",
- "mirror-region": {
- "Worldwide": {
- "https://mirror.rackspace.com/archlinux/$repo/os/$arch": true
- }
- },
+ "mirror-region": "Worldwide",
"nic": {
"NetworkManager": true
},
+ "ntp": true,
"packages": ["docker", "git", "wget", "zsh"],
"profile": "gnome",
"services": ["docker"],
@@ -82,6 +80,8 @@ Installing directly from a config file
"!password": "devel"
}
},
+ "sys-encoding": "utf-8",
+ "sys-language": "en_US",
"timezone": "US/Eastern",
"users": {}
}
@@ -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 the 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 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
============================