1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
|
.. _guided:
Guided installation
===================
Archinstall ships with a pre-programmed `Guided Installer`_ guiding you through the mandatory steps as well as some optional configurations that can be done.
.. note::
Other pre-programmed scripts can be invoked by executing :code:`archinstall <script>` *(without .py)*. To see a complete list of scripts, run :code:`archinstall --script list` or check the source code `scripts`_ directory.
.. note::
It's recommended to run ``archinstall`` from the official Arch Linux ISO.
.. warning::
The installer will not configure WiFi before the installation begins. You need to read up on `Arch Linux networking <https://wiki.archlinux.org/index.php/Network_configuration>`_ before you continue.
Running the guided installation
-------------------------------
To start the installer, run the following in the latest Arch Linux ISO:
.. code-block:: sh
archinstall
Since the `Guided Installer`_ is the default script, this is the equivalent of running :code:`archinstall guided`
The guided installation also supports installing with pre-configured answers to all the guided steps. This can be a quick and convenient way to re-run one or several installations.
There are two configuration files, both are optional.
``--config``
------------
This parameter takes a local or remote :code:`.json` file as argument and contains the overall configuration and menu answers for the guided installer.
.. note::
You can always get the latest options for this file with ``archinstall --dry-run``, this executes the guided installer in a safe mode where no permanent actions will be taken on your system but simulate a run and save the configuration to disk.
Example usage
^^^^^^^^^^^^^
.. code-block:: sh
archinstall --config https://domain.lan/config.json
The contents of :code:`https://domain.lan/config.json`:
.. code-block:: json
{
"__separator__": null,
"additional-repositories": [],
"archinstall-language": "English",
"audio_config": null,
"bootloader": "Systemd-boot",
"config_version": "2.6.0",
"debug": false,
"disk_config": {
"config_type": "manual_partitioning",
"device_modifications": [
{
"device": "/dev/sda",
"partitions": [
{
"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"
},
{
"btrfs": [],
"flags": [],
"fs_type": "fat32",
"length": {
"sector_size": null,
"total_size": null,
"unit": "B",
"value": 100000000
},
"mount_options": [],
"mountpoint": "/efi",
"obj_id": "13cf2c96-8b0f-4ade-abaa-c530be589aad",
"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": 100
},
"status": "create",
"type": "primary"
},
{
"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"
}
],
"wipe": false
}
]
},
"disk_encryption": {
"encryption_type": "luks",
"partitions": [
"3e75d045-21a4-429d-897e-8ec19a006e8b"
]
},
"hostname": "archlinux",
"kernels": [
"linux"
],
"locale_config": {
"kb_layout": "us",
"sys_enc": "UTF-8",
"sys_lang": "en_US"
},
"mirror_config": {
"custom_mirrors": [],
"mirror_regions": {
"Sweden": [
"https://mirror.osbeck.com/archlinux/$repo/os/$arch",
"https://mirror.bahnhof.net/pub/archlinux/$repo/os/$arch",
"https://ftp.myrveln.se/pub/linux/archlinux/$repo/os/$arch",
"https://ftp.lysator.liu.se/pub/archlinux/$repo/os/$arch",
"https://ftp.ludd.ltu.se/mirrors/archlinux/$repo/os/$arch",
"https://ftp.acc.umu.se/mirror/archlinux/$repo/os/$arch",
"http://mirror.bahnhof.net/pub/archlinux/$repo/os/$arch",
"http://ftpmirror.infania.net/mirror/archlinux/$repo/os/$arch",
"http://ftp.myrveln.se/pub/linux/archlinux/$repo/os/$arch",
"http://ftp.lysator.liu.se/pub/archlinux/$repo/os/$arch",
"http://ftp.acc.umu.se/mirror/archlinux/$repo/os/$arch"
]
}
},
"network_config": {},
"no_pkg_lookups": false,
"ntp": true,
"offline": false,
"packages": [],
"parallel downloads": 0,
"profile_config": null,
"save_config": null,
"script": "guided",
"silent": false,
"swap": true,
"timezone": "UTC",
"version": "2.6.0"
}
``--config`` options
^^^^^^^^^^^^^^^^^^^^
.. warning::
All key and value entries must conform to the JSON standard. Below is human readable examples with links, effectively breaking the syntax. Adapt the descriptions below to suit your needs and the JSON format.
.. note::
Scroll to the right in the table to see required options.
.. csv-table:: JSON options
:file: ../cli_parameters/config/config_options.csv
:widths: 15, 40, 40, 5
:escape: !
:header-rows: 1
.. I'd like to keep this note, as this is the intended behavior of archinstall.
.. note::
If no entries are found in ``disk_config``, archinstall guided installation will use whatever is mounted currently under ``/mnt/archinstall`` without performing any disk operations.
Options for ``--creds``
-----------------------
| Creds is a separate configuration file to separate normal options from more sensitive data like passwords.
| Below is an example of how to set the root password and below that are description of other values that can be set.
.. code-block:: json
{
"!root-password" : "SecretSanta2022"
}
.. list-table:: --creds options
:widths: 25 25 40 10
:header-rows: 1
* - Key
- Values
- Description
- Required
* - !encryption-password
- ``str``
- Password to encrypt disk, not encrypted if password not provided
- No
* - !root-password
- ``str``
- The root account password
- No
* - !users
- .. code-block:: json
{
"username": "<USERNAME>",
"!password": "<PASSWORD>",
"sudo": false
}
- List of regular user credentials, see configuration for reference
- Maybe
.. note::
``!users`` is optional only if ``!root-password`` was set. ``!users`` will be enforced otherwise and the minimum amount of users with sudo privileges required will be set to 1.
.. note::
The key's start with ``!`` because internal log functions will mask any keys starting with explamation from logs and unrestricted configurations.
.. _scripts: https://github.com/archlinux/archinstall/tree/master/archinstall/scripts
.. _Guided Installer: https://github.com/archlinux/archinstall/blob/master/archinstall/scripts/guided.py
|