Skip to content

Commit 7370e52

Browse files
TorxedTorxed
committed
Added custom-commands docs, and improved some creds and known issue links
1 parent 6fec39a commit 7370e52

File tree

4 files changed

+69
-18
lines changed

4 files changed

+69
-18
lines changed

‎docs/cli_parameters/config/config_options.csv

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ disk_config,*Read more under* :ref:`disk config`,Contains the desired disk setup
88
disk_encryption,*Read more about under* :ref:`disk encryption`,Parameters for disk encryption applied ontop of ``disk_config``,No
99
hostname,``str``,A string definining your machines hostname on the network *(defaults to ``archinstall``)*,No
1010
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
11-
custom-commands,[ <command1>!, <command2>!, ...],Custom commands that will be run post-install chrooted inside the installed system,No
11+
custom-commands,*Read more under* :ref:`custom commands`,Custom commands that will be run post-install chrooted inside the installed system,No
1212
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
1313
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
1414
network_config,*`see options under Network Configuration`*,Sets which type of *(if any)* network configuration should be used,No

‎docs/cli_parameters/config/custom_commands.rst

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
.. _custom commands:
2+
3+
Custom Commands
4+
===============
5+
6+
| Custom commands is a configuration entry that allows for executing custom commands post-installation.
7+
| The commands are executed with `arch-chroot <https://man.archlinux.org/man/extra/arch-install-scripts/arch-chroot.8.en>`_.
8+
9+
The option takes a list of arguments, an example is:
10+
11+
.. code-block:: json
12+
13+
{
14+
"custom-commands": [
15+
"hostname new-hostname"
16+
]
17+
}
18+
19+
| The following example will set a new hostname in the installed system.
20+
| 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.
21+
22+
More examples can be found in the code repository under `examples/ <https://github.com/archlinux/archinstall/tree/e6344f93f7e476d05bbcd642f2ed91fdde545870/examples>`_

‎docs/help/known_issues.rst

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,12 @@
1-
.. _help.issues:
1+
.. _help.known_issues:
22

33
Known Issues
44
============
55

66
| Some issues are out of the `archinstall`_ projects scope, and the ones we know of are listed below.
77
88
.. _waiting for time sync:
9+
910
Waiting for time sync `#2144`_
1011
------------------------------
1112

‎docs/installing/guided.rst

+44-16
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
Guided installation
44
===================
55

6-
Archinstall ships with a pre-programmed `Guided Installer <https://github.com/archlinux/archinstall/blob/master/archinstall/scripts/guided.py>`_ guiding you through the mandatory steps as well as some optional configurations that can be done.
6+
Archinstall ships with a pre-programmed `Guided Installer`_ guiding you through the mandatory steps as well as some optional configurations that can be done.
77

88
.. note::
99

@@ -26,7 +26,7 @@ To start the installer, run the following in the latest Arch Linux ISO:
2626
2727
archinstall
2828
29-
Since the guided installer is the default script, this is the equvilant of running :code:`archinstall guided`
29+
Since the `Guided Installer`_ is the default script, this is the equvilant of running :code:`archinstall guided`
3030

3131

3232
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.
@@ -216,14 +216,21 @@ The contents of :code:`https://domain.lan/config.json`:
216216
``--config`` options
217217
^^^^^^^^^^^^^^^^^^^^
218218

219-
*(Scroll to the right in the table to see required options.)*
219+
.. warning::
220+
221+
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.
222+
223+
.. note::
224+
225+
Scroll to the right in the table to see required options.
220226

221227
.. csv-table:: JSON options
222228
:file: ../cli_parameters/config/config_options.csv
223229
:widths: 15, 40, 40, 5
224230
:escape: !
225231
:header-rows: 1
226232

233+
.. I'd like to keep this note, as this is the intended behavior of archinstall.
227234
.. note::
228235

229236
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.
@@ -240,20 +247,41 @@ Options for ``--creds``
240247
"!root-password" : "SecretSanta2022"
241248
}
242249
243-
+----------------------+--------------------------------------------------------+--------------------------------------------------------------------------------------+-----------------------------------------------+
244-
| Key | Values | Description | Required |
245-
+======================+========================================================+======================================================================================+===============================================+
246-
| !encryption-password | any | Password to encrypt disk, not encrypted if password not provided | No |
247-
+----------------------+--------------------------------------------------------+--------------------------------------------------------------------------------------+-----------------------------------------------+
248-
| !root-password | any | The root account password | No |
249-
+----------------------+--------------------------------------------------------+--------------------------------------------------------------------------------------+-----------------------------------------------+
250-
| !users | { "username": "<USERNAME>" | List of regular user credentials, see configuration for reference | No |
251-
| | "!password": "<PASSWORD>", | | |
252-
| | "sudo": false|true} | | |
253-
+----------------------+--------------------------------------------------------+--------------------------------------------------------------------------------------+-----------------------------------------------+
250+
.. list-table:: --creds options
251+
:widths: 25 25 40 10
252+
:header-rows: 1
253+
254+
* - Key
255+
- Values
256+
- Description
257+
- Required
258+
* - !encryption-password
259+
- ``str``
260+
- Password to encrypt disk, not encrypted if password not provided
261+
- No
262+
* - !root-password
263+
- ``str``
264+
- The root account password
265+
- No
266+
* - !users
267+
- .. code-block:: json
268+
269+
{
270+
"username": "<USERNAME>",
271+
"!password": "<PASSWORD>",
272+
"sudo": false
273+
}
274+
- List of regular user credentials, see configuration for reference
275+
- Maybe
276+
277+
278+
.. note::
279+
280+
``!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.
254281

255282
.. note::
256-
``!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.
257283

284+
The key's start with ``!`` because internal log functions will mask any keys starting with explamation from logs and unrestricted configurations.
258285

259-
.. _scripts: https://github.com/archlinux/archinstall/tree/master/archinstall/scripts
286+
.. _scripts: https://github.com/archlinux/archinstall/tree/master/archinstall/scripts
287+
.. _Guided Installer: https://github.com/archlinux/archinstall/blob/master/archinstall/scripts/guided.py

0 commit comments

Comments
 (0)