commit 76a7f9d4d92f654d7f8d0dd13be4a1ab45350f50 Author: Torxed Date: Sun Jun 28 20:07:10 2026 +0000 deploy: 3ece182d31dda7b14abd56d13abf3ff79a5717ae diff --git a/.buildinfo b/.buildinfo new file mode 100644 index 00000000..f522fd8d --- /dev/null +++ b/.buildinfo @@ -0,0 +1,4 @@ +# Sphinx build info version 1 +# This file records the configuration used when building these files. When it is not found, a full rebuild will be done. +config: a6d5ef5bf34b59b03c781f0b1d997b20 +tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/.doctrees/archinstall/Installer.doctree b/.doctrees/archinstall/Installer.doctree new file mode 100644 index 00000000..6c5387c4 Binary files /dev/null and b/.doctrees/archinstall/Installer.doctree differ diff --git a/.doctrees/archinstall/plugins.doctree b/.doctrees/archinstall/plugins.doctree new file mode 100644 index 00000000..b4c52268 Binary files /dev/null and b/.doctrees/archinstall/plugins.doctree differ diff --git a/.doctrees/cli_parameters/config/custom_commands.doctree b/.doctrees/cli_parameters/config/custom_commands.doctree new file mode 100644 index 00000000..7ba0be5a Binary files /dev/null and b/.doctrees/cli_parameters/config/custom_commands.doctree differ diff --git a/.doctrees/cli_parameters/config/disk_config.doctree b/.doctrees/cli_parameters/config/disk_config.doctree new file mode 100644 index 00000000..fd8cf462 Binary files /dev/null and b/.doctrees/cli_parameters/config/disk_config.doctree differ diff --git a/.doctrees/cli_parameters/config/disk_encryption.doctree b/.doctrees/cli_parameters/config/disk_encryption.doctree new file mode 100644 index 00000000..2f700eae Binary files /dev/null and b/.doctrees/cli_parameters/config/disk_encryption.doctree differ diff --git a/.doctrees/environment.pickle b/.doctrees/environment.pickle new file mode 100644 index 00000000..0fb9ef78 Binary files /dev/null and b/.doctrees/environment.pickle differ diff --git a/.doctrees/examples/python.doctree b/.doctrees/examples/python.doctree new file mode 100644 index 00000000..a4fb2fbb Binary files /dev/null and b/.doctrees/examples/python.doctree differ diff --git a/.doctrees/help/discord.doctree b/.doctrees/help/discord.doctree new file mode 100644 index 00000000..053d4f02 Binary files /dev/null and b/.doctrees/help/discord.doctree differ diff --git a/.doctrees/help/known_issues.doctree b/.doctrees/help/known_issues.doctree new file mode 100644 index 00000000..5ff057ec Binary files /dev/null and b/.doctrees/help/known_issues.doctree differ diff --git a/.doctrees/help/report_bug.doctree b/.doctrees/help/report_bug.doctree new file mode 100644 index 00000000..e78220ce Binary files /dev/null and b/.doctrees/help/report_bug.doctree differ diff --git a/.doctrees/index.doctree b/.doctrees/index.doctree new file mode 100644 index 00000000..b548477c Binary files /dev/null and b/.doctrees/index.doctree differ diff --git a/.doctrees/installing/guided.doctree b/.doctrees/installing/guided.doctree new file mode 100644 index 00000000..f43967cf Binary files /dev/null and b/.doctrees/installing/guided.doctree differ diff --git a/.doctrees/installing/python.doctree b/.doctrees/installing/python.doctree new file mode 100644 index 00000000..eff1a8a4 Binary files /dev/null and b/.doctrees/installing/python.doctree differ diff --git a/.nojekyll b/.nojekyll new file mode 100644 index 00000000..e69de29b diff --git a/CNAME b/CNAME new file mode 100644 index 00000000..46d218c4 --- /dev/null +++ b/CNAME @@ -0,0 +1 @@ +archinstall.archlinux.page diff --git a/_sources/archinstall/Installer.rst.txt b/_sources/archinstall/Installer.rst.txt new file mode 100644 index 00000000..d1bbaa7c --- /dev/null +++ b/_sources/archinstall/Installer.rst.txt @@ -0,0 +1,11 @@ +.. _archinstall.Installer: + +archinstall.Installer +===================== + +The installer is the main class for accessing an installation-instance. +You can look at this class as the installation you have or will perform. + +Anything related to **inside** the installation, will be found in this class. + +.. autofunction:: archinstall.Installer diff --git a/_sources/archinstall/plugins.rst.txt b/_sources/archinstall/plugins.rst.txt new file mode 100644 index 00000000..1022ab6f --- /dev/null +++ b/_sources/archinstall/plugins.rst.txt @@ -0,0 +1,57 @@ +.. _archinstall.Plugins: + +Python Plugins +============== + +``archinstall`` supports plugins via two methods. + +First method is directly via the ``--plugin`` parameter when running as a CLI tool. This will load a specific plugin locally or remotely via a path. + +The second method is via Python's built in `plugin discovery`_ using `entry points`_ categorized as ``archinstall.plugin``. + +``--plugin`` parameter +---------------------- + +The parameter has the benefit of being stored in the ``--conf`` state, meaning when re-running an installation — the plugin will automatically be loaded. +It's limitation is that it requires an initial path to be known and written and be cumbersome. + +Plugin Discovery +---------------- + +This method allows for multiple plugins to be loaded with the drawback that they have to be installed beforehand on the system running ``archinstall``. +This mainly targets those who build their own ISO's and package specific setups for their needs. + + +What's supported? +----------------- + +Currently the documentation for this is scarse. Until that is resolved, the best way to find supported features is to search the source code for `plugin.on_ `_ as this will give a clear indication of which calls are made to plugins. + +How does it work? +----------------- + +``archinstall`` plugins use a discovery-driven approach where plugins are queried for certain functions. +As an example, if a plugin has the following function: + +.. code-block:: python + + def on_pacstrap(*packages): + ... + +The function :code:`archinstall.Pacman().strap(["some packages"])` is hardcoded to iterate plugins and look for :code:`on_pacstrap` in the plugin. +If the function exists, :code:`.strap()` will call the plugin's function and replace the initial package list with the result from the plugin. + +The best way to document these calls is currently undecided, as it's hard to document this behavior dynamically. + +Writing your own? +----------------- + +The simplest way currently is to look at a reference implementation or the community. Two of these are: + +* `torxed/archinstall-aur `_ +* `phisch/archinstall-aur `_ + +And search for `plugin.on_ `_ in the code base to find what ``archinstall`` will look for. PR's are welcome to widen the support for this. + +.. _plugin discovery: https://packaging.python.org/en/latest/specifications/entry-points/ +.. _entry points: https://docs.python.org/3/library/importlib.metadata.html#entry-points diff --git a/_sources/cli_parameters/config/custom_commands.rst.txt b/_sources/cli_parameters/config/custom_commands.rst.txt new file mode 100644 index 00000000..6234bd9e --- /dev/null +++ b/_sources/cli_parameters/config/custom_commands.rst.txt @@ -0,0 +1,22 @@ +.. _custom commands: + +Custom Commands +=============== + +Custom commands is a configuration entry that allows for executing custom commands post-installation. +The commands are executed with `arch-chroot `_. + +The option takes a list of arguments, an example is: + +.. code-block:: json + + { + "custom_commands": [ + "hostname new-hostname" + ] + } + +The following example will set a new hostname in the installed system. +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. + +More examples can be found in the code repository under `examples/ `_ diff --git a/_sources/cli_parameters/config/disk_config.rst.txt b/_sources/cli_parameters/config/disk_config.rst.txt new file mode 100644 index 00000000..1f499777 --- /dev/null +++ b/_sources/cli_parameters/config/disk_config.rst.txt @@ -0,0 +1,231 @@ +.. _disk config: + +Disk Configuration +================== + +There are only three modes in the ``disk_config`` option. They are described in more detail below. + +"Leave as is" +-------------- + +.. code-block:: json + + { + "config_type": "pre_mounted_config", + "mountpoint": "/mnt/archinstall" + } + +This mode will not perform any partitioning what so ever. +Instead it relies on what's mounted manually by the user under ``/mnt/archinstall``. + +Given the following disk example: + +.. code-block:: + + /mnt/archinstall (/dev/sda2) + ├── boot (/dev/sda1) + └── home (/dev/sda3) + +Running ``archinstall --conf your.json --silent`` where the above JSON is configured. The disk will be left alone — and a working system will be installed to the above folders and mountpoints will be translated into the installed system. + +.. note:: + + Some disk layouts can be too complicated to detect, such as RAID setups. Please do report those setups on the `Issue Tracker `__ so we can support them. + +Best Effort +----------- + +.. warning:: + + This mode will wipe data! + +.. note:: + + Note that this options is similar to the manual partitioning but is generated through the menu system! And the best effort layout might deviate slightly from some wiki guidelines in order to facilitate some optional configurations at a later stage. + +.. code-block:: json + + { + "disk_config": { + "config_type": "default_layout", + "device_modifications": [ + { + "device": "/dev/sda", + "wipe": true, + "partitions": "..." + } + ] + } + } + +This mode will attempt to configure a sane default layout on the selected disks. +Based on the chosen filesystem, and potential optional settings for said filesystem — different default layouts will be provided. + +Manual Partitioning +------------------- + +.. code-block:: json + + { + "disk_config": { + "config_type": "manual_partitioning", + "device_modifications": [ + "filesystem struct" + ] + } + } + +Manual partitioning is the most complex one of the three. It offers you near endless flexibility of how to partition your disk. It integrates against `pyparted `__ and some control logic in ``archinstall`` that deals with creating things like subvolumes and compression. + +Sizes are by default ``sector`` units, but other units are supported. + +The options supplied to ``manual_partitioning`` are dictionary definitions, where the following parameters must exist: + +.. csv-table:: JSON options + :file: ./manual_options.csv + :widths: 15, 15, 65, 5 + :escape: ! + :header-rows: 1 + +Each partition definition heavily relies on what filesystem is used. +Below follow two of the more common filesystems, anything else will best be described by running ``archinstall`` to generate a desired configuration for the desired filesystem type — and copy the relevant parts for permanent configurations. + +.. warning:: + + Important to note that the units and positions in the examples below — are highly user specific! + +FAT32 +^^^^^ + +.. code-block:: json + + { + "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" + } + +.. note:: + + The ``Boot`` flag will make ``archinstall`` automatically set the correct ESP partition GUID if the system is booted with ``EFI`` support. The GUID will then be set to ``C12A7328-F81F-11D2-BA4B-00A0C93EC93B``. + +EXT4 +^^^^ + +.. code-block:: json + + { + "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" + } + +BTRFS +^^^^^ + +The BTRFS filesystem is inherently more complicated, thus the options are a bit more involved. +This example contains both subvolumes and compression. + +.. note:: + + Note that the ``"mountpoint": null`` is used for the overall partition, and instead individual subvolumes have mountpoints set. + +.. code-block:: json + + { + "btrfs": [ + { + "mountpoint": "/", + "name": "@", + }, + { + "mountpoint": "/home", + "name": "@home", + }, + { + "mountpoint": "/var/log", + "name": "@log", + }, + { + "mountpoint": "/var/cache/pacman/pkg", + "name": "@pkg", + } + ], + "dev_path": null, + "flags": [], + "fs_type": "btrfs", + "mount_options": [ + "compress=zstd" + ], + "mountpoint": null, + "obj_id": "d712357f-97cc-40f8-a095-24ff244d4539", + "size": { + "sector_size": { + "unit": "B", + "value": 512 + }, + "unit": "B", + "value": 15568207872 + }, + "start": { + "sector_size": { + "unit": "B", + "value": 512 + }, + "unit": "MiB", + "value": 513 + }, + "status": "create", + "type": "primary" + } diff --git a/_sources/cli_parameters/config/disk_encryption.rst.txt b/_sources/cli_parameters/config/disk_encryption.rst.txt new file mode 100644 index 00000000..9be5e480 --- /dev/null +++ b/_sources/cli_parameters/config/disk_encryption.rst.txt @@ -0,0 +1,19 @@ +.. _disk encryption: + +Disk Encryption +=============== + +Disk encryption consists of a top level entry in the user configuration. + +.. code-block:: json + + { + "disk_encryption": { + "encryption_type": "luks", + "partitions": [ + "d712357f-97cc-40f8-a095-24ff244d4539" + ] + } + } + +The ``UID`` in the ``partitions`` list is an internal reference to the ``obj_id`` in the :ref:`disk config` entries. diff --git a/_sources/examples/python.rst.txt b/_sources/examples/python.rst.txt new file mode 100644 index 00000000..1243aca5 --- /dev/null +++ b/_sources/examples/python.rst.txt @@ -0,0 +1,97 @@ +.. _examples.python: + +Python module +============= + +Archinstall supports running in `module mode `_. +The way the library is invoked in module mode is limited to executing scripts under the `scripts`_ folder. + +It's therefore important to place any script or profile you wish to invoke in the examples folder prior to building and installing. + +Pre-requisites +-------------- + +We'll assume you've followed the :ref:`installing.python.manual` method. +Before actually installing the library, you will need to place your custom installer-scripts under `scripts`_ as a python file. + +More on how you create these in the next section. + +.. warning:: + + This is subject to change in the future as this method is currently a bit stiff. The script path will become a parameter. But for now, this is by design. + +Creating a script +----------------- + +Lets create a `test_installer` - installer as an example. This is assuming that the folder `./archinstall` is a git-clone of the main repo. +We begin by creating "`scripts`_:code:`/test_installer.py`". The placement here is important later. + +This script can now already be called using :code:`python -m archinstall --script test_installer` after a successful installation of the library itself. +But the script won't do much. So we'll do something simple like list all the hard drives as an example. + +To do this, we'll begin by importing :code:`archinstall` in our "`scripts`_:code:`/test_installer.py`" and call a function within ``archinstall``. + +.. code-block:: python + + from archinstall.lib.disk.device_handler import device_handler + from pprint import pprint + + pprint(device_handler.devices) + +Now, go ahead and reference the :ref:`installing.python.manual` installation method. +After running ``python -m archinstall test_installer`` it should print something that looks like: + +.. code-block:: text + + [ + BDevice( + disk=, + device_info=_DeviceInfo( + model='PC801 NVMe SK hynix 512GB', + path=PosixPath('/dev/nvme0n1'), + type='nvme', + total_size=Size(value=512110190592, unit=, + sector_size=SectorSize(value=512, unit=)), + free_space_regions=[ + , + , + ], + sector_size=SectorSize(value=512, unit=), + read_only=False, + dirty=False + ), + partition_infos=[ + _PartitionInfo( + partition=, + name='primary', + type=, + fs_type=, + path='/dev/nvme0n1p1', + start=Size(value=2048, unit=, sector_size=SectorSize(value=512, unit=)), + length=Size(value=535822336, unit=, sector_size=SectorSize(value=512, unit=)), + flags=[ + , + + ], + partn=1, + partuuid='a26be943-c193-41f4-9930-9341cf5f6b19', + uuid='6EE9-2C00', + disk=, + mountpoints=[ + PosixPath('/boot') + ], + btrfs_subvol_infos=[] + ), + _PartitionInfo(...) + ] + ) + ] + +That means your script is in the right place, and ``archinstall`` is working as intended. + +.. note:: + + Most calls, including the one above requires `root `_ privileges. + + +.. _scripts: https://github.com/archlinux/archinstall/tree/master/archinstall/scripts diff --git a/_sources/help/discord.rst.txt b/_sources/help/discord.rst.txt new file mode 100644 index 00000000..88ef3548 --- /dev/null +++ b/_sources/help/discord.rst.txt @@ -0,0 +1,14 @@ +.. _help.discord: + +Discord +======= + +There's a discord channel which is frequented by some `contributors `_. + +To join the server, head over to `https://discord.gg/aDeMffrxNg `_ and join in. +There's not many rules other than common sense and to treat others with respect. The general chat is for off-topic things as well. + +There's the ``@Party Animals`` role if you want notifications of new releases which is posted in the ``#Release Party`` channel. +Another thing is the ``@Contributors`` role can be activated by contributors by writing ``!verify`` and follow the verification process. + +Hop in, we hope to see you there! : ) diff --git a/_sources/help/known_issues.rst.txt b/_sources/help/known_issues.rst.txt new file mode 100644 index 00000000..90945894 --- /dev/null +++ b/_sources/help/known_issues.rst.txt @@ -0,0 +1,136 @@ +.. _help.known_issues: + +Known Issues +============ + +Some issues are out of the `archinstall`_ projects scope, and the ones we know of are listed below. + +.. _waiting for time sync: + +Waiting for time sync `#2144`_ +------------------------------ + +The usual root cause of this is the network topology. +More specifically `timedatectl show`_ cannot perform a proper time sync against the default servers. + +Restarting ``systemd-timesyncd.service`` might work but most often you need to configure ``/etc/systemd/timesyncd.conf`` to match your network design. + +.. note:: + + If you know your time is correct on the machine, you can run ``archinstall --skip-ntp`` to ignore time sync. + +Waiting for Arch Linux keyring sync (archlinux-keyring-wkd-sync) to complete. `#2679`_ +------------------------------ + +The ``archlinux-keyring-wkd-sync.service`` or ``archlinux-keyring-wkd-sync.timer`` can hang "indefinitely" sometimes. +This is usually due to an inability to reach the key servers, or a slow connection towards key servers. + +The script ``/usr/bin/archlinux-keyring-wkd-sync`` can be run manually, to verify if it's executing slowly or not. + +If ``systemctl show --property=ActiveEnterTimestamp --no-pager archlinux-keyring-wkd-sync.timer`` shows nothing, it means the built-in sync never finished. Likewise ``systemctl show --no-pager -p SubState --value archlinux-keyring-wkd-sync.service`` most likely shows ``dead``, which means the service never completed. + +To fix this, try the following: + +.. code-block:: console + + # killall gpg-agent + # rm -rf /etc/pacman.d/gnupg + # pacman-key --init + # pacman-key --populate + # pacman -Sy archlinux-keyring + # systemctl restart archlinux-keyring-wkd-sync.timer + +.. note:: + + If you know the ISO is the latest, and that you have valid GPG keys, try ``archinstall --skip-wkd`` to ignore waiting for the sync. + + If you skip WKD sync, you might end up with: + + .. code-block:: console + + > error: archinstall: signature from "Anton Hvornum (Torxed) " is unknown trust + > :: File /var/cache/pacman/pkg/archinstall-1.2.3-4-x86_64.pkg.tar.xz is corrupted (invalid or corrupted package (PGP signature)). + > Do you want to delete it? [Y/n] + +Missing Nvidia Proprietary Driver `#2002`_ +------------------------------------------ + +In some instances, the nvidia driver might not have all the necessary packages installed. +This is due to the kernel selection and/or hardware setups requiring additional packages to work properly. + +A common workaround is to install the package `linux-headers`_ and `nvidia-dkms`_ + +ARM, 32bit and other CPU types error out `#1686`_, `#2185`_ +----------------------------------------------------------- + +This is a bit of a catch-all known issue. +Officially `x86_64`_ is only supported by Arch Linux. +Hence little effort has been put into supporting other platforms. + +In theory, other architectures should work but small quirks might arise. + +PR's are welcome but please be respectful of the delays in merging. +Other fixes, issues or features will be prioritized for the above reasons. + +Keyring is out of date `#2213`_ +------------------------------- + +Missing key-issues tend to be that the `archlinux-keyring`_ package is out of date, usually as a result of an outdated ISO. +There is an attempt from upstream to fix this issue, and it's the `archlinux-keyring-wkd-sync.service`_ + +The service starts almost immediately during boot, and if network is not configured in time — the service will fail. +Subsequently the ``archinstall`` run might operate on an old keyring despite there being an update service for this. + +There is really no way to reliably over time work around this issue in ``archinstall``. +Instead, efforts to the upstream service should be considered the way forward. And/or keys not expiring between a sane amount of ISOs. + +.. note:: + + The issue can happen on new ISO's too even as little as a few days after release, as some keys might expire right after the keyring is *"burnt in"* to the ISO. + +.. note:: + + Another common issue relating to the network not being configured, is that time might not be set correctly - resulting in the keyring not being able to update. See :ref:`waiting for time sync`. + +AUR packages +------------ + +This is also a catch-all issue. +`AUR is unsupported `_, and until that changes we cannot use AUR packages to solve feature requests in ``archinstall``. + +This means that feature requests like supporting filesystems such as `ZFS`_ can not be added, and issues cannot be solved by using AUR packages either. + +.. note:: + + But in spirit of giving the community options, ``archinstall`` supports :ref:`archinstall.Plugins`, which means you can run ``archinstall --plugin `` and source an AUR plugin. + + `torxed/archinstall-aur `_ is a reference implementation for plugins: + + .. code-block:: console + + # archinstall --plugin https://archlinux.life/aur-plugin + + `phisch/archinstall-aur `_ is another alternative: + + .. code-block:: console + + # archinstall --plugin https://raw.githubusercontent.com/phisch/archinstall-aur/master/archinstall-aur.py + + .. warning:: + + This will allow for unsupported usage of AUR during installation. + +.. _#1686: https://github.com/archlinux/archinstall/issues/1686 +.. _#2002: https://github.com/archlinux/archinstall/issues/2002 +.. _#2144: https://github.com/archlinux/archinstall/issues/2144 +.. _#2185: https://github.com/archlinux/archinstall/issues/2185 +.. _#2213: https://github.com/archlinux/archinstall/issues/2213 +.. _#2679: https://github.com/archlinux/archinstall/issues/2679 +.. _linux-headers: https://archlinux.org/packages/core/x86_64/linux-headers/ +.. _nvidia-dkms: https://archlinux.org/packages/extra/x86_64/nvidia-dkms/ +.. _x86_64: https://wiki.archlinux.org/title/Frequently_asked_questions#What_architectures_does_Arch_support? +.. _archlinux-keyring: https://archlinux.org/packages/core/any/archlinux-keyring/ +.. _archlinux-keyring-wkd-sync.service: https://gitlab.archlinux.org/archlinux/archlinux-keyring/-/blob/7e672dad10652a80d1cc575d75cdb46442cd7f96/wkd_sync/archlinux-keyring-wkd-sync.service.in +.. _ZFS: https://aur.archlinux.org/packages/zfs-linux +.. _archinstall: https://github.com/archlinux/archinstall/ +.. _timedatectl show: https://github.com/archlinux/archinstall/blob/e6344f93f7e476d05bbcd642f2ed91fdde545870/archinstall/lib/installer.py#L136 diff --git a/_sources/help/report_bug.rst.txt b/_sources/help/report_bug.rst.txt new file mode 100644 index 00000000..b11027ab --- /dev/null +++ b/_sources/help/report_bug.rst.txt @@ -0,0 +1,33 @@ +.. _help.issues: + +Report Issues & Bugs +==================== + +Issues and bugs should be reported over at `https://github.com/archlinux/archinstall/issues `_. + +General questions, enhancements and security issues can be reported over there too. +For quick issues or if you need help, head over to the Discord server which has a help channel. + +Log files +--------- + +When submitting a help ticket, please include the :code:`/var/log/archinstall/install.log`. +It can be found both on the live ISO but also in the installed filesystem if the base packages were strapped in. + +.. tip:: + | An easy way to submit logs is ``archinstall share-log``, which uploads ``install.log`` to paste.rs and prints a shareable URL. + | Use caution when submitting other log files, but ``archinstall`` pledges to keep ``install.log`` safe for posting publicly! + +There are additional log files under ``/var/log/archinstall/`` that can be useful: + + - ``/var/log/archinstall/user_configuration.json`` - Stores most of the guided answers in the installer + - ``/var/log/archinstall/user_credentials.json`` - Stores any usernames or passwords, can be passed to ``--creds`` + - ``/var/log/archinstall/user_disk_layouts.json`` - Stores the chosen disks and their layouts + - ``/var/log/archinstall/install.log`` - A log file over what steps were taken by archinstall + - ``/var/log/archinstall/cmd_history.txt`` - A complete command history, command by command in order + - ``/var/log/archinstall/cmd_output.txt`` - A raw output from all the commands that were executed by archinstall + +.. warning:: + + We only try to guarantee that ``/var/log/archinstall/install.log`` is free from sensitive information. + Any other log file should be pasted with **utmost care**! diff --git a/_sources/index.rst.txt b/_sources/index.rst.txt new file mode 100644 index 00000000..9759524b --- /dev/null +++ b/_sources/index.rst.txt @@ -0,0 +1,41 @@ +archinstall Documentation +========================= + +**archinstall** is a library which can be used to install Arch Linux. +The library comes packaged with different pre-configured installers, such as the default :ref:`guided` installer. + +Some of the features of Archinstall are: + +* **Context friendly.** The library always executes calls in sequential order to ensure installation-steps don't overlap or execute in the wrong order. It also supports *(and uses)* context wrappers to ensure cleanup and final tasks such as ``mkinitcpio`` are called when needed. + +* **Full transparency** Logs and insights can be found at ``/var/log/archinstall`` both in the live ISO and partially on the installed system. + +* **Accessibility friendly** Archinstall works with ``espeakup`` and other accessibility tools thanks to the use of a TUI. + +.. toctree:: + :maxdepth: 1 + :caption: Running Archinstall + + installing/guided + +.. toctree:: + :maxdepth: 3 + :caption: Getting help + + help/known_issues + help/report_bug + help/discord + +.. toctree:: + :maxdepth: 3 + :caption: Archinstall as a library + + installing/python + examples/python + archinstall/plugins + +.. toctree:: + :maxdepth: 3 + :caption: API Reference + + archinstall/Installer diff --git a/_sources/installing/guided.rst.txt b/_sources/installing/guided.rst.txt new file mode 100644 index 00000000..562d2b29 --- /dev/null +++ b/_sources/installing/guided.rst.txt @@ -0,0 +1,302 @@ +.. _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 + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
    • +
  • archinstall.Installer
    • +
  • +
    • +
+
+
+
+
+ +
+

archinstall.Installer

+

The installer is the main class for accessing an installation-instance. +You can look at this class as the installation you have or will perform.

+

Anything related to inside the installation, will be found in this class.

+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/archinstall/plugins.html b/archinstall/plugins.html new file mode 100644 index 00000000..61742975 --- /dev/null +++ b/archinstall/plugins.html @@ -0,0 +1,173 @@ + + + + + + + + + Python Plugins — python-archinstall v2.3.0 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
    • +
  • Python Plugins
    • +
  • +
    • +
+
+
+
+
+ +
+

Python Plugins

+

archinstall supports plugins via two methods.

+

First method is directly via the --plugin parameter when running as a CLI tool. This will load a specific plugin locally or remotely via a path.

+

The second method is via Python’s built in plugin discovery using entry points categorized as archinstall.plugin.

+
+

--plugin parameter

+

The parameter has the benefit of being stored in the --conf state, meaning when re-running an installation — the plugin will automatically be loaded. +It’s limitation is that it requires an initial path to be known and written and be cumbersome.

+
+
+

Plugin Discovery

+

This method allows for multiple plugins to be loaded with the drawback that they have to be installed beforehand on the system running archinstall. +This mainly targets those who build their own ISO’s and package specific setups for their needs.

+
+
+

What’s supported?

+

Currently the documentation for this is scarse. Until that is resolved, the best way to find supported features is to search the source code for plugin.on_ as this will give a clear indication of which calls are made to plugins.

+
+
+

How does it work?

+

archinstall plugins use a discovery-driven approach where plugins are queried for certain functions. +As an example, if a plugin has the following function:

+
def on_pacstrap(*packages):
+    ...
+
+
+

The function archinstall.Pacman().strap(["some packages"]) is hardcoded to iterate plugins and look for on_pacstrap in the plugin. +If the function exists, .strap() will call the plugin’s function and replace the initial package list with the result from the plugin.

+

The best way to document these calls is currently undecided, as it’s hard to document this behavior dynamically.

+
+
+

Writing your own?

+

The simplest way currently is to look at a reference implementation or the community. Two of these are:

+ +

And search for plugin.on_ in the code base to find what archinstall will look for. PR’s are welcome to widen the support for this.

+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/cli_parameters/config/custom_commands.html b/cli_parameters/config/custom_commands.html new file mode 100644 index 00000000..e3f046ab --- /dev/null +++ b/cli_parameters/config/custom_commands.html @@ -0,0 +1,136 @@ + + + + + + + + + Custom Commands — python-archinstall v2.3.0 documentation + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
    • +
  • Custom Commands
    • +
  • +
    • +
+
+
+
+
+ +
+

Custom Commands

+

Custom commands is a configuration entry that allows for executing custom commands post-installation. +The commands are executed with arch-chroot.

+

The option takes a list of arguments, an example is:

+
{
+    "custom_commands": [
+        "hostname new-hostname"
+    ]
+}
+
+
+

The following example will set a new hostname in the installed system. +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.

+

More examples can be found in the code repository under examples/

+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/cli_parameters/config/disk_config.html b/cli_parameters/config/disk_config.html new file mode 100644 index 00000000..f6eb3230 --- /dev/null +++ b/cli_parameters/config/disk_config.html @@ -0,0 +1,360 @@ + + + + + + + + + Disk Configuration — python-archinstall v2.3.0 documentation + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
    • +
  • Disk Configuration
    • +
  • +
    • +
+
+
+
+
+ +
+

Disk Configuration

+

There are only three modes in the disk_config option. They are described in more detail below.

+
+

“Leave as is”

+
{
+    "config_type": "pre_mounted_config",
+    "mountpoint": "/mnt/archinstall"
+}
+
+
+

This mode will not perform any partitioning what so ever. +Instead it relies on what’s mounted manually by the user under /mnt/archinstall.

+

Given the following disk example:

+
/mnt/archinstall    (/dev/sda2)
+     ├── boot       (/dev/sda1)
+     └── home       (/dev/sda3)
+
+
+

Running archinstall --conf your.json --silent where the above JSON is configured. The disk will be left alone — and a working system will be installed to the above folders and mountpoints will be translated into the installed system.

+
+

Note

+

Some disk layouts can be too complicated to detect, such as RAID setups. Please do report those setups on the Issue Tracker so we can support them.

+
+
+
+

Best Effort

+
+

Warning

+

This mode will wipe data!

+
+
+

Note

+

Note that this options is similar to the manual partitioning but is generated through the menu system! And the best effort layout might deviate slightly from some wiki guidelines in order to facilitate some optional configurations at a later stage.

+
+
{
+    "disk_config": {
+        "config_type": "default_layout",
+        "device_modifications": [
+            {
+                "device": "/dev/sda",
+                "wipe": true,
+                "partitions": "..."
+            }
+        ]
+    }
+}
+
+
+

This mode will attempt to configure a sane default layout on the selected disks. +Based on the chosen filesystem, and potential optional settings for said filesystem — different default layouts will be provided.

+
+
+

Manual Partitioning

+
{
+     "disk_config": {
+         "config_type": "manual_partitioning",
+         "device_modifications": [
+            "filesystem struct"
+         ]
+     }
+ }
+
+
+

Manual partitioning is the most complex one of the three. It offers you near endless flexibility of how to partition your disk. It integrates against pyparted and some control logic in archinstall that deals with creating things like subvolumes and compression.

+

Sizes are by default sector units, but other units are supported.

+

The options supplied to manual_partitioning are dictionary definitions, where the following parameters must exist:

+ + ++++++ + + + + + + + + + + + + + + + + + + + + + + + + +
JSON options

Key

Value(s)

Description

Required

device

str

Which block-device to format

yes

partitions

[ {key: val} ]

The data describing the change/addition in a partition

yes

wipe

bool

clear the disk before adding any partitions

No

+

Each partition definition heavily relies on what filesystem is used. +Below follow two of the more common filesystems, anything else will best be described by running archinstall to generate a desired configuration for the desired filesystem type — and copy the relevant parts for permanent configurations.

+
+

Warning

+

Important to note that the units and positions in the examples below — are highly user specific!

+
+
+

FAT32

+
{
+        "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"
+}
+
+
+
+

Note

+

The Boot flag will make archinstall automatically set the correct ESP partition GUID if the system is booted with EFI support. The GUID will then be set to C12A7328-F81F-11D2-BA4B-00A0C93EC93B.

+
+
+
+

EXT4

+
     {
+   "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"
+}
+
+
+
+
+

BTRFS

+

The BTRFS filesystem is inherently more complicated, thus the options are a bit more involved. +This example contains both subvolumes and compression.

+
+

Note

+

Note that the "mountpoint": null is used for the overall partition, and instead individual subvolumes have mountpoints set.

+
+
{
+   "btrfs": [
+       {
+           "mountpoint": "/",
+           "name": "@",
+       },
+       {
+           "mountpoint": "/home",
+           "name": "@home",
+       },
+       {
+           "mountpoint": "/var/log",
+           "name": "@log",
+       },
+       {
+           "mountpoint": "/var/cache/pacman/pkg",
+           "name": "@pkg",
+       }
+   ],
+   "dev_path": null,
+   "flags": [],
+   "fs_type": "btrfs",
+   "mount_options": [
+       "compress=zstd"
+   ],
+   "mountpoint": null,
+   "obj_id": "d712357f-97cc-40f8-a095-24ff244d4539",
+   "size": {
+       "sector_size": {
+           "unit": "B",
+           "value": 512
+       },
+       "unit": "B",
+       "value": 15568207872
+   },
+   "start": {
+       "sector_size": {
+           "unit": "B",
+           "value": 512
+       },
+       "unit": "MiB",
+       "value": 513
+   },
+   "status": "create",
+   "type": "primary"
+}
+
+
+
+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/cli_parameters/config/disk_encryption.html b/cli_parameters/config/disk_encryption.html new file mode 100644 index 00000000..85e5aef1 --- /dev/null +++ b/cli_parameters/config/disk_encryption.html @@ -0,0 +1,135 @@ + + + + + + + + + Disk Encryption — python-archinstall v2.3.0 documentation + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
    • +
  • Disk Encryption
    • +
  • +
    • +
+
+
+
+
+ +
+

Disk Encryption

+

Disk encryption consists of a top level entry in the user configuration.

+
{
+     "disk_encryption": {
+         "encryption_type": "luks",
+         "partitions": [
+             "d712357f-97cc-40f8-a095-24ff244d4539"
+         ]
+     }
+}
+
+
+

The UID in the partitions list is an internal reference to the obj_id in the Disk Configuration entries.

+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/examples/python.html b/examples/python.html new file mode 100644 index 00000000..18c27993 --- /dev/null +++ b/examples/python.html @@ -0,0 +1,211 @@ + + + + + + + + + Python module — python-archinstall v2.3.0 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
    • +
  • Python module
    • +
  • +
    • +
+
+
+
+
+ +
+

Python module

+

Archinstall supports running in module mode. +The way the library is invoked in module mode is limited to executing scripts under the scripts folder.

+

It’s therefore important to place any script or profile you wish to invoke in the examples folder prior to building and installing.

+
+

Pre-requisites

+

We’ll assume you’ve followed the Install using source code method. +Before actually installing the library, you will need to place your custom installer-scripts under scripts as a python file.

+

More on how you create these in the next section.

+
+

Warning

+

This is subject to change in the future as this method is currently a bit stiff. The script path will become a parameter. But for now, this is by design.

+
+
+
+

Creating a script

+

Lets create a test_installer - installer as an example. This is assuming that the folder ./archinstall is a git-clone of the main repo. +We begin by creating “scripts/test_installer.py”. The placement here is important later.

+

This script can now already be called using python -m archinstall --script test_installer after a successful installation of the library itself. +But the script won’t do much. So we’ll do something simple like list all the hard drives as an example.

+

To do this, we’ll begin by importing archinstall in our “scripts/test_installer.py” and call a function within archinstall.

+
from archinstall.lib.disk.device_handler import device_handler
+from pprint import pprint
+
+pprint(device_handler.devices)
+
+
+

Now, go ahead and reference the Install using source code installation method. +After running python -m archinstall test_installer it should print something that looks like:

+
[
+    BDevice(
+        disk=<parted.disk.Disk object at 0x7fbe17156050>,
+        device_info=_DeviceInfo(
+            model='PC801 NVMe SK hynix 512GB',
+            path=PosixPath('/dev/nvme0n1'),
+            type='nvme',
+            total_size=Size(value=512110190592, unit=<Unit.B: 1>,
+            sector_size=SectorSize(value=512, unit=<Unit.B: 1>)),
+            free_space_regions=[
+                <archinstall.lib.disk.device.DeviceGeometry object at 0x7fbe166c4250>,
+                <archinstall.lib.disk.device.DeviceGeometry object at 0x7fbe166c4c50>,
+                <archinstall.lib.disk.device.DeviceGeometry object at 0x7fbe166c4a10>],
+            sector_size=SectorSize(value=512, unit=<Unit.B: 1>),
+            read_only=False,
+            dirty=False
+        ),
+        partition_infos=[
+            _PartitionInfo(
+                partition=<parted.partition.Partition object at 0x7fbe166c4a90>,
+                name='primary',
+                type=<PartitionType.PRIMARY: 'primary'>,
+                fs_type=<FilesystemType.FAT32: 'fat32'>,
+                path='/dev/nvme0n1p1',
+                start=Size(value=2048, unit=<Unit.sectors: 'sectors'>, sector_size=SectorSize(value=512, unit=<Unit.B: 1>)),
+                length=Size(value=535822336, unit=<Unit.B: 1>, sector_size=SectorSize(value=512, unit=<Unit.B: 1>)),
+                flags=[
+                    <PartitionFlag.BOOT: flag_id=1, alias=None>,
+                    <PartitionFlag.ESP: flag_id=18, alias=None>
+                ],
+                partn=1,
+                partuuid='a26be943-c193-41f4-9930-9341cf5f6b19',
+                uuid='6EE9-2C00',
+                disk=<parted.disk.Disk object at 0x7fbe17156050>,
+                mountpoints=[
+                    PosixPath('/boot')
+                ],
+                btrfs_subvol_infos=[]
+            ),
+            _PartitionInfo(...)
+        ]
+    )
+]
+
+
+

That means your script is in the right place, and archinstall is working as intended.

+
+

Note

+

Most calls, including the one above requires root privileges.

+
+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/genindex-all.html b/genindex-all.html new file mode 100644 index 00000000..c8645461 --- /dev/null +++ b/genindex-all.html @@ -0,0 +1,125 @@ + + + + + + + + Index — python-archinstall v2.3.0 documentation + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
    • +
  • Index
    • +
  • +
    • +
+
+
+
+
+ + +

Index

+ +
+ +
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/genindex.html b/genindex.html new file mode 100644 index 00000000..c66a9d1a --- /dev/null +++ b/genindex.html @@ -0,0 +1,130 @@ + + + + + + + + Index — python-archinstall v2.3.0 documentation + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
    • +
  • Index
    • +
  • +
    • +
+
+
+
+
+ + +

Index

+ +

Index pages by letter:

+ +
+

+ +

Full index on one page + (can be huge)

+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/help/discord.html b/help/discord.html new file mode 100644 index 00000000..cb397b52 --- /dev/null +++ b/help/discord.html @@ -0,0 +1,134 @@ + + + + + + + + + Discord — python-archinstall v2.3.0 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
    • +
  • Discord
    • +
  • +
    • +
+
+
+
+
+ +
+

Discord

+

There’s a discord channel which is frequented by some contributors.

+

To join the server, head over to https://discord.gg/aDeMffrxNg and join in. +There’s not many rules other than common sense and to treat others with respect. The general chat is for off-topic things as well.

+

There’s the @Party Animals role if you want notifications of new releases which is posted in the #Release Party channel. +Another thing is the @Contributors role can be activated by contributors by writing !verify and follow the verification process.

+

Hop in, we hope to see you there! : )

+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/help/known_issues.html b/help/known_issues.html new file mode 100644 index 00000000..503b810a --- /dev/null +++ b/help/known_issues.html @@ -0,0 +1,227 @@ + + + + + + + + + Known Issues — python-archinstall v2.3.0 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
    • +
  • Known Issues
    • +
  • +
    • +
+
+
+
+
+ +
+

Known Issues

+

Some issues are out of the archinstall projects scope, and the ones we know of are listed below.

+
+

Waiting for time sync #2144

+

The usual root cause of this is the network topology. +More specifically timedatectl show cannot perform a proper time sync against the default servers.

+

Restarting systemd-timesyncd.service might work but most often you need to configure /etc/systemd/timesyncd.conf to match your network design.

+
+

Note

+

If you know your time is correct on the machine, you can run archinstall --skip-ntp to ignore time sync.

+
+
+
+

Waiting for Arch Linux keyring sync (archlinux-keyring-wkd-sync) to complete. #2679

+

The archlinux-keyring-wkd-sync.service or archlinux-keyring-wkd-sync.timer can hang “indefinitely” sometimes. +This is usually due to an inability to reach the key servers, or a slow connection towards key servers.

+

The script /usr/bin/archlinux-keyring-wkd-sync can be run manually, to verify if it’s executing slowly or not.

+

If systemctl show --property=ActiveEnterTimestamp --no-pager archlinux-keyring-wkd-sync.timer shows nothing, it means the built-in sync never finished. Likewise systemctl show --no-pager -p SubState --value archlinux-keyring-wkd-sync.service most likely shows dead, which means the service never completed.

+

To fix this, try the following:

+
# killall gpg-agent
+# rm -rf /etc/pacman.d/gnupg
+# pacman-key --init
+# pacman-key --populate
+# pacman -Sy archlinux-keyring
+# systemctl restart archlinux-keyring-wkd-sync.timer
+
+
+
+

Note

+

If you know the ISO is the latest, and that you have valid GPG keys, try archinstall --skip-wkd to ignore waiting for the sync.

+

If you skip WKD sync, you might end up with:

+
> error: archinstall: signature from "Anton Hvornum (Torxed) <torxed@archlinux.org>" is unknown trust
+> :: File /var/cache/pacman/pkg/archinstall-1.2.3-4-x86_64.pkg.tar.xz is corrupted (invalid or corrupted package (PGP signature)).
+> Do you want to delete it? [Y/n]
+
+
+
+
+
+

Missing Nvidia Proprietary Driver #2002

+

In some instances, the nvidia driver might not have all the necessary packages installed. +This is due to the kernel selection and/or hardware setups requiring additional packages to work properly.

+

A common workaround is to install the package linux-headers and nvidia-dkms

+
+
+

ARM, 32bit and other CPU types error out #1686, #2185

+

This is a bit of a catch-all known issue. +Officially x86_64 is only supported by Arch Linux. +Hence little effort has been put into supporting other platforms.

+

In theory, other architectures should work but small quirks might arise.

+

PR’s are welcome but please be respectful of the delays in merging. +Other fixes, issues or features will be prioritized for the above reasons.

+
+
+

Keyring is out of date #2213

+

Missing key-issues tend to be that the archlinux-keyring package is out of date, usually as a result of an outdated ISO. +There is an attempt from upstream to fix this issue, and it’s the archlinux-keyring-wkd-sync.service

+

The service starts almost immediately during boot, and if network is not configured in time — the service will fail. +Subsequently the archinstall run might operate on an old keyring despite there being an update service for this.

+

There is really no way to reliably over time work around this issue in archinstall. +Instead, efforts to the upstream service should be considered the way forward. And/or keys not expiring between a sane amount of ISOs.

+
+

Note

+

The issue can happen on new ISO’s too even as little as a few days after release, as some keys might expire right after the keyring is “burnt in” to the ISO.

+
+
+

Note

+

Another common issue relating to the network not being configured, is that time might not be set correctly - resulting in the keyring not being able to update. See Waiting for time sync #2144.

+
+
+
+

AUR packages

+

This is also a catch-all issue. +AUR is unsupported, and until that changes we cannot use AUR packages to solve feature requests in archinstall.

+

This means that feature requests like supporting filesystems such as ZFS can not be added, and issues cannot be solved by using AUR packages either.

+
+

Note

+

But in spirit of giving the community options, archinstall supports Python Plugins, which means you can run archinstall --plugin <url> and source an AUR plugin.

+

torxed/archinstall-aur is a reference implementation for plugins:

+
# archinstall --plugin https://archlinux.life/aur-plugin
+
+
+

phisch/archinstall-aur is another alternative:

+
# archinstall --plugin https://raw.githubusercontent.com/phisch/archinstall-aur/master/archinstall-aur.py
+
+
+
+

Warning

+

This will allow for unsupported usage of AUR during installation.

+
+
+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/help/report_bug.html b/help/report_bug.html new file mode 100644 index 00000000..259fd5c2 --- /dev/null +++ b/help/report_bug.html @@ -0,0 +1,162 @@ + + + + + + + + + Report Issues & Bugs — python-archinstall v2.3.0 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
    • +
  • Report Issues & Bugs
    • +
  • +
    • +
+
+
+
+
+ +
+

Report Issues & Bugs

+

Issues and bugs should be reported over at https://github.com/archlinux/archinstall/issues.

+

General questions, enhancements and security issues can be reported over there too. +For quick issues or if you need help, head over to the Discord server which has a help channel.

+
+

Log files

+

When submitting a help ticket, please include the /var/log/archinstall/install.log. +It can be found both on the live ISO but also in the installed filesystem if the base packages were strapped in.

+
+

Tip

+
+
An easy way to submit logs is archinstall share-log, which uploads install.log to paste.rs and prints a shareable URL.
+
Use caution when submitting other log files, but archinstall pledges to keep install.log safe for posting publicly!
+
+
+

There are additional log files under /var/log/archinstall/ that can be useful:

+
+
    +

  • /var/log/archinstall/user_configuration.json - Stores most of the guided answers in the installer

    • +

  • /var/log/archinstall/user_credentials.json - Stores any usernames or passwords, can be passed to --creds

    • +

  • /var/log/archinstall/user_disk_layouts.json - Stores the chosen disks and their layouts

    • +

  • /var/log/archinstall/install.log - A log file over what steps were taken by archinstall

    • +

  • /var/log/archinstall/cmd_history.txt - A complete command history, command by command in order

    • +

  • /var/log/archinstall/cmd_output.txt - A raw output from all the commands that were executed by archinstall

    • +
+
+
+

Warning

+

We only try to guarantee that /var/log/archinstall/install.log is free from sensitive information. +Any other log file should be pasted with utmost care!

+
+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/index.html b/index.html new file mode 100644 index 00000000..c3866460 --- /dev/null +++ b/index.html @@ -0,0 +1,189 @@ + + + + + + + + + archinstall Documentation — python-archinstall v2.3.0 documentation + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
    • +
  • archinstall Documentation
    • +
  • +
    • +
+
+
+
+
+ +
+

archinstall Documentation

+

archinstall is a library which can be used to install Arch Linux. +The library comes packaged with different pre-configured installers, such as the default Guided installation installer.

+

Some of the features of Archinstall are:

+
    +

  • Context friendly. The library always executes calls in sequential order to ensure installation-steps don’t overlap or execute in the wrong order. It also supports (and uses) context wrappers to ensure cleanup and final tasks such as mkinitcpio are called when needed.

    • +

  • Full transparency Logs and insights can be found at /var/log/archinstall both in the live ISO and partially on the installed system.

    • +

  • Accessibility friendly Archinstall works with espeakup and other accessibility tools thanks to the use of a TUI.

    • +
+
+

Running Archinstall

+ +
+
+

Getting help

+ +
+
+

Archinstall as a library

+ +
+
+

API Reference

+ +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/installing/guided.html b/installing/guided.html new file mode 100644 index 00000000..8f1c0826 --- /dev/null +++ b/installing/guided.html @@ -0,0 +1,554 @@ + + + + + + + + + Guided installation — python-archinstall v2.3.0 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
    • +
  • Guided installation
    • +
  • +
    • +
+
+
+
+
+ +
+

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 archinstall --script <script> (without .py). To see a complete list of scripts, run 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 before you continue.

+
+
+

Running the guided installation

+

To start the installer, run the following in the latest Arch Linux ISO:

+
archinstall
+
+
+

Since the Guided Installer is the default script, this is the equivalent of running 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 .json file as argument and contains the overall configuration and menu answers for the guided installer.

+
+
+

--config-url

+

This parameter takes a remote .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

+
archinstall --config config.json
+
+
+
archinstall --config-url https://domain.lan/config.json
+
+
+

The contents of https://domain.lan/config.json:

+
{
+  "additional-repositories": [],
+  "archinstall-language": "English",
+  "audio_config": null,
+  "bootloader_config": {
+    "bootloader": "Systemd-boot",
+    "uki": false,
+    "removable": false
+  },
+  "bootloader": "Systemd-boot",
+  "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_servers": [
+      {
+        "url": "https://mymirror.com/$repo/os/$arch"
+      }
+    ],
+    "mirror_regions": {
+      "Australia": [
+        "http://archlinux.mirror.digitalpacific.com.au/$repo/os/$arch"
+      ]
+    },
+    "optional_repositories": [
+      "testing"
+    ],
+    "custom_repositories": [
+      {
+        "name": "myrepo",
+        "url": "https://myrepo.com/$repo/os/$arch",
+        "sign_check": "Required",
+        "sign_option": "TrustAll"
+      }
+    ]
+  },
+  "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.

+
+ + ++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
JSON options

Key

Value(s)

Description

Required

additional-repositories

[ multilib, testing ]

Enables one or more of the testing and multilib repositories before proceeding with installation

No

archinstall-language

lang

Sets the TUI language used (make sure to use the ``lang`` value not the ``abbr``)

No

audio_config

pipewire, pulseaudio

Audioserver to be installed

No

bootloader_config

{ bootloader: Systemd-boot, grub, limine, uki: true/false, removable: true/false }

Bootloader configuration. bootloader selects which bootloader to install (grub/limine mandatory on BIOS). uki enables unified kernel images (UEFI only, systemd-boot/limine only). removable installs to default removable media path /EFI/BOOT/ instead of NVRAM (UEFI only, grub/limine only)

Yes

debug

true, false

Enables debug output

No

disk_config

Read more under Disk Configuration

Contains the desired disk setup to be used during installation

No

disk_encryption

Read more about under Disk Encryption

Parameters for disk encryption applied on top of disk_config

No

hostname

str

A string defining your machines hostname on the network (defaults to ``archinstall``)

No

kernels

[ linux, linux-hardened, linux-lts, linux-rt, linux-rt-lts, linux-zen ]

Defines which kernels should be installed and setup in the boot loader options

Yes

custom_commands

Read more under Custom Commands

Custom commands that will be run post-install chrooted inside the installed system

No

locale_config

{kb_layout: lang, sys_enc: Character encoding, sys_lang: locale}

Defines the keyboard key map, system encoding and system locale

No

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

network_config

`see options under Network Configuration`

Sets which type of (if any) network configuration should be used

No

no_pkg_lookups

true, false

Disabled package checking against https://archlinux.org/packages/

No

ntp

true, false

enables or disables NTP during installation

No

offline

true, false

enables or disables certain online checks such as mirror reachability etc

No

packages

[ <package1>, <package2>, … ]

A list of packages to install during installation

No

parallel downloads

0-∞

sets a given number of parallel downloads to be used by pacman

No

profile_config

`read more under the profiles section`

Installs a given profile if defined

No

script

guided (default), minimal, only_hdd, When used to autorun an installation, this sets which script to autorun with

No

silent

true, false

disables or enables user questions using the TUI

No

swap

true, false

enables or disables swap

No

timezone

timezone

sets a timezone for the installed system

No

+
+

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.

+
{
+    "root_enc_password" : "SecretSanta2022"
+}
+
+
+ + ++++++ + + + + + + + + + + + + + + + + + + + + + + + + +
--creds options

Key

Values

Description

Required

!encryption-password

str

Password to encrypt disk, not encrypted if password not provided

No

root_enc_password

str

The root account password

No

users

{
+    "username": "<USERNAME>",
+    "enc_password": "<PASSWORD_HASH>",
+    "sudo": false
+}
+
+
+

List of regular user credentials, see configuration for reference

Maybe

+
+

Note

+

users is optional only if root_enc_password was set. users will be enforced otherwise and the minimum amount of users with sudo privileges required will be set to 1.

+
+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/installing/python.html b/installing/python.html new file mode 100644 index 00000000..98668c1c --- /dev/null +++ b/installing/python.html @@ -0,0 +1,174 @@ + + + + + + + + + Python library — python-archinstall v2.3.0 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
    • +
  • Python library
    • +
  • +
    • +
+
+
+
+
+ +
+

Python library

+

Archinstall ships on PyPi as archinstall. +But the library can be installed manually as well.

+
+

Warning

+

These steps are not required if you want to use archinstall on the official Arch Linux ISO.

+
+
+

Installing with pacman

+

Archinstall is on the official repositories. +And it will also install archinstall as a python library.

+

To install both the library and the archinstall script:

+
pacman -S archinstall
+
+
+

Alternatively, you can install only the library and not the helper executable using the python-archinstall package.

+
+
+

Installing from PyPI

+

The basic concept of PyPI applies using pip.

+
pip install archinstall
+
+
+
+
+

Install using source code

+

You can also install using the source code. +For sake of simplicity we will use git clone in this example.

+
git clone https://github.com/archlinux/archinstall
+
+
+

You can either move the folder into your project and simply do

+
import archinstall
+
+
+

Or you can PyPa’s build and installer to install it into pythons module path.

+
$ cd archinstall
+$ python -m build .
+$ python -m installer dist/*.whl
+
+
+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/objects.inv b/objects.inv new file mode 100644 index 00000000..f6cc7d89 Binary files /dev/null and b/objects.inv differ diff --git a/search.html b/search.html new file mode 100644 index 00000000..ad50b8a0 --- /dev/null +++ b/search.html @@ -0,0 +1,140 @@ + + + + + + + + Search — python-archinstall v2.3.0 documentation + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
    • +
  • Search
    • +
  • +
    • +
+
+
+
+
+ + + + +
+ +
+ +
+
+ +
+
+
+
+ + + + + + + + + \ No newline at end of file diff --git a/searchindex.js b/searchindex.js new file mode 100644 index 00000000..61be50bb --- /dev/null +++ b/searchindex.js @@ -0,0 +1 @@ +Search.setIndex({"alltitles":{"--config":[[10,"config"]],"--config options":[[10,"config-options"]],"--config-url":[[10,"config-url"]],"--creds options":[[10,"id2"]],"--plugin parameter":[[1,"plugin-parameter"]],"API Reference":[[9,null]],"ARM, 32bit and other CPU types error out #1686, #2185":[[7,"arm-32bit-and-other-cpu-types-error-out-1686-2185"]],"AUR packages":[[7,"aur-packages"]],"Archinstall as a library":[[9,null]],"BTRFS":[[3,"btrfs"]],"Best Effort":[[3,"best-effort"]],"Creating a script":[[5,"creating-a-script"]],"Custom Commands":[[2,null]],"Discord":[[6,null]],"Disk Configuration":[[3,null]],"Disk Encryption":[[4,null]],"EXT4":[[3,"ext4"]],"Example usage":[[10,"example-usage"]],"FAT32":[[3,"fat32"]],"Getting help":[[9,null]],"Guided installation":[[10,null]],"How does it work?":[[1,"how-does-it-work"]],"Install using source code":[[11,"install-using-source-code"]],"Installing from PyPI":[[11,"installing-from-pypi"]],"Installing with pacman":[[11,"installing-with-pacman"]],"JSON options":[[3,"id1"],[10,"id1"]],"Keyring is out of date #2213":[[7,"keyring-is-out-of-date-2213"]],"Known Issues":[[7,null]],"Log files":[[8,"log-files"]],"Manual Partitioning":[[3,"manual-partitioning"]],"Missing Nvidia Proprietary Driver #2002":[[7,"missing-nvidia-proprietary-driver-2002"]],"Options for --creds":[[10,"options-for-creds"]],"Plugin Discovery":[[1,"plugin-discovery"]],"Pre-requisites":[[5,"pre-requisites"]],"Python Plugins":[[1,null]],"Python library":[[11,null]],"Python module":[[5,null]],"Report Issues & Bugs":[[8,null]],"Running Archinstall":[[9,null]],"Running the guided installation":[[10,"running-the-guided-installation"]],"Waiting for Arch Linux keyring sync (archlinux-keyring-wkd-sync) to complete. #2679":[[7,"waiting-for-arch-linux-keyring-sync-archlinux-keyring-wkd-sync-to-complete-2679"]],"Waiting for time sync #2144":[[7,"waiting-for-time-sync-2144"]],"What\u2019s supported?":[[1,"what-s-supported"]],"Writing your own?":[[1,"writing-your-own"]],"archinstall Documentation":[[9,null]],"archinstall.Installer":[[0,null]],"\u201cLeave as is\u201d":[[3,"leave-as-is"]]},"docnames":["archinstall/Installer","archinstall/plugins","cli_parameters/config/custom_commands","cli_parameters/config/disk_config","cli_parameters/config/disk_encryption","examples/python","help/discord","help/known_issues","help/report_bug","index","installing/guided","installing/python"],"envversion":{"sphinx":66,"sphinx.domains.c":3,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":9,"sphinx.domains.index":1,"sphinx.domains.javascript":3,"sphinx.domains.math":2,"sphinx.domains.python":4,"sphinx.domains.rst":2,"sphinx.domains.std":2,"sphinx.ext.todo":2},"filenames":["archinstall/Installer.rst","archinstall/plugins.rst","cli_parameters/config/custom_commands.rst","cli_parameters/config/disk_config.rst","cli_parameters/config/disk_encryption.rst","examples/python.rst","help/discord.rst","help/known_issues.rst","help/report_bug.rst","index.rst","installing/guided.rst","installing/python.rst"],"indexentries":{},"objects":{},"objnames":{},"objtypes":{},"terms":{"00a0c93ec93b":3,"0x7fbe166c4250":5,"0x7fbe166c4a10":5,"0x7fbe166c4a90":5,"0x7fbe166c4c50":5,"0x7fbe17156050":5,"11d2":3,"13cf2c96":10,"21a4":[3,10],"24ff244d4539":[3,4],"2c00":5,"32bit":9,"369f31a8":[3,10],"3e75d045":[3,10],"40f8":[3,4],"41f4":5,"429d":[3,10],"4ade":10,"4d6b":[3,10],"512gb":5,"6ee9":5,"75680552b7c9":[3,10],"897e":[3,10],"8b0f":10,"8ec19a006e8b":[3,10],"9341cf5f6b19":5,"96e7":[3,10],"97cc":[3,4],"A":[7,8,10],"After":5,"All":10,"An":8,"And":[1,3,7,11],"As":1,"Below":[3,10],"But":[5,7,11],"Do":7,"Each":3,"For":[8,11],"How":9,"If":[1,7,10],"In":7,"It":[1,3,5,8,9,10],"More":[2,5,7],"Most":5,"No":[3,10],"Or":11,"Other":[7,10],"So":5,"Some":[3,7,9],"That":5,"The":[0,1,2,3,4,5,6,7,9,10,11],"There":[3,6,7,8,10],"These":11,"They":3,"This":[1,3,5,7,10],"To":[5,6,7,10,11],"Until":1,"We":[5,8],"What":9,"When":[8,10],"Which":3,"You":[0,10,11],"_deviceinfo":5,"_partitioninfo":5,"a095":[3,4],"a26be943":5,"abaa":10,"abbr":10,"abl":7,"abov":[3,5,7],"access":[0,9],"account":10,"action":10,"activ":6,"activeentertimestamp":7,"actual":5,"adapt":10,"add":[3,7],"addit":[3,7,8,10],"ademffrxng":6,"agent":7,"ahead":5,"alia":5,"allow":[1,2,7],"almost":7,"alon":3,"alreadi":5,"also":[7,8,9,10,11],"altern":[7,11],"alway":[9,10],"amount":[7,10],"ani":[3,5,8,10],"anim":6,"anoth":[6,7],"answer":[8,10],"anton":7,"anyth":[0,3],"appli":[10,11],"approach":1,"arch":[2,9,10,11],"archinstal":[1,3,5,7,8,10,11],"architectur":7,"archlinux":[8,9,10,11],"argument":[2,10],"aris":7,"arm":9,"around":7,"assum":5,"attempt":[3,7],"au":10,"audio_config":10,"audioserv":10,"aur":[1,9],"australia":10,"automat":[1,3],"autorun":10,"b":[3,5,10],"ba4b":3,"base":[1,2,3,8],"basic":11,"bdevic":5,"becom":5,"befor":[3,5,10],"beforehand":1,"begin":[5,10],"behavior":1,"benefit":1,"best":1,"bin":7,"bio":10,"bit":[3,5,7],"block":3,"bool":3,"boot":[3,5,7,10],"bootload":10,"bootloader_config":10,"break":10,"btrfs":10,"btrfs_subvol_info":5,"bug":9,"build":[1,5,11],"built":[1,7],"burnt":7,"c12a7328":3,"c193":5,"c530be589aad":10,"cach":[3,7],"call":[1,5,9],"can":[0,2,3,5,6,7,8,9,10,11],"care":8,"catch":7,"categor":1,"caus":7,"caution":8,"cd":11,"certain":[1,10],"chang":[3,5,7],"channel":[6,8],"charact":10,"chat":6,"check":10,"chosen":[3,8],"chroot":[2,10],"class":0,"cleanup":9,"clear":[1,3],"cli":1,"clone":[5,11],"cmd_histori":8,"cmd_output":8,"code":[1,2,5,9,10],"com":[7,8,10,11],"come":9,"command":[8,10],"common":[3,6,7],"communiti":[1,7],"complet":[8,9,10],"complex":3,"complic":3,"compress":3,"concept":11,"conf":[1,3,7],"config_typ":[3,10],"configur":[2,4,7,9,10],"conform":10,"connect":7,"consid":7,"consist":4,"contain":[3,10],"content":10,"context":9,"continu":10,"contributor":6,"control":3,"conveni":10,"copi":3,"correct":[3,7],"corrupt":7,"cpu":9,"creat":[3,9,10],"cred":8,"credenti":10,"cumbersom":1,"current":[1,5,10],"custom":[5,10],"custom_command":[2,10],"custom_mirror":10,"custom_repositori":10,"custom_serv":10,"d":[7,10],"d712357f":[3,4],"data":[3,10],"date":9,"day":7,"dead":7,"deal":3,"debug":10,"def":1,"default":[3,7,9,10],"default_layout":3,"defin":10,"definit":3,"delay":7,"delet":7,"describ":3,"descript":[3,10],"design":[5,7],"desir":[3,10],"despit":7,"detail":3,"detect":3,"dev":[3,5,10],"dev_path":3,"deviat":3,"devic":[3,5,10],"device_handl":5,"device_info":5,"device_modif":[3,10],"devicegeometri":5,"dictionari":3,"differ":[3,9],"digitalpacif":10,"direct":1,"directori":10,"dirti":5,"disabl":10,"discord":[8,9],"discoveri":9,"disk":[5,8,10],"disk_config":[3,10],"disk_encrypt":[4,10],"dist":11,"dkms":7,"document":1,"doe":9,"domain":10,"don":9,"done":10,"download":10,"drawback":1,"dri":10,"drive":5,"driven":1,"driver":9,"due":7,"dure":[7,10],"dynam":1,"easi":8,"effect":10,"effort":7,"efi":[3,10],"either":[7,11],"els":3,"en_us":10,"enabl":10,"enc_password":10,"encod":10,"encrypt":10,"encryption_typ":[4,10],"end":7,"endless":3,"enforc":10,"english":10,"enhanc":8,"ensur":9,"entri":[1,2,4,10],"equival":10,"error":9,"esp":[3,5],"espeakup":9,"etc":[7,10],"even":7,"ever":3,"exampl":[1,2,3,5,11],"execut":[2,5,7,8,9,10,11],"exist":[1,3],"expir":7,"ext4":10,"f81f":3,"facilit":3,"fail":7,"fals":[5,10],"fat32":[5,10],"featur":[1,7,9],"file":[5,7,9,10],"filesystem":[3,7,8],"filesystemtyp":5,"final":9,"find":1,"finish":7,"first":1,"fix":7,"flag":[3,5,10],"flag_id":5,"flexibl":3,"folder":[3,5,11],"follow":[1,2,3,5,6,7,10],"format":[3,10],"forward":7,"found":[0,2,8,9,10],"free":8,"free_space_region":5,"frequent":6,"friend":9,"fs_type":[3,5,10],"full":9,"function":[1,5],"futur":5,"general":[6,8],"generat":3,"geo":10,"get":10,"gg":6,"git":[5,11],"github":[8,11],"githubusercont":7,"give":[1,7],"given":[3,10],"gnupg":7,"go":5,"gpg":7,"grub":10,"guarante":8,"guid":[3,8,9],"guidelin":3,"hang":7,"happen":7,"hard":[1,5],"hardcod":1,"harden":10,"hardwar":7,"head":[6,8],"header":7,"heavili":3,"help":8,"helper":11,"henc":7,"high":3,"histori":8,"home":3,"hop":6,"hope":6,"hostnam":[2,10],"http":10,"https":[6,7,8,10,11],"human":10,"hvornum":7,"hynix":5,"ignor":7,"illustr":2,"imag":10,"immedi":7,"implement":[1,7],"import":[3,5,11],"inabl":7,"includ":[5,8],"indefinit":7,"indic":1,"individu":3,"inform":8,"inher":3,"init":7,"initi":1,"insid":[0,2,10],"insight":9,"instal":[1,2,3,5,7,8,9],"instanc":[0,7],"instead":[3,7,10],"integr":3,"intend":5,"internal":4,"invalid":7,"invok":[5,10],"involv":3,"iso":[1,2,7,8,9,10,11],"issu":[3,9],"iter":1,"join":6,"json":8,"just":2,"kb_layout":10,"keep":8,"kernel":[7,10],"key":[3,7,10],"keyboard":10,"keyr":9,"killal":7,"know":7,"known":[1,9],"lan":10,"lang":10,"languag":10,"later":[3,5],"latest":[7,10],"layout":[3,8],"left":3,"length":[3,5,10],"let":5,"level":4,"lib":5,"librari":5,"life":7,"like":[3,5,7,10],"likewis":7,"limin":10,"limit":[1,5],"link":10,"linux":[9,10,11],"list":[1,2,4,5,7,10],"littl":7,"live":[8,9],"ll":5,"load":1,"loader":10,"local":[1,10],"locale_config":10,"log":[3,9],"logic":3,"look":[0,1,5],"lts":10,"luk":[4,10],"m":[5,11],"machin":[7,10],"made":1,"main":[0,1,5],"make":[3,10],"mandatori":10,"mani":6,"manual":[7,11],"manual_partit":[3,10],"map":10,"master":7,"match":7,"mayb":10,"mb":[3,10],"mean":[1,5,7],"media":10,"menu":[3,10],"merg":7,"method":[1,5],"mib":3,"might":[3,7],"minim":10,"minimum":10,"mirror":10,"mirror_config":10,"mirror_region":10,"miss":9,"mkinitcpio":9,"mnt":[3,10],"mode":[3,5,10],"model":5,"modul":[9,11],"mount":[3,10],"mount_opt":[3,10],"mountpoint":[3,5,10],"move":11,"much":5,"multilib":10,"multipl":1,"must":[3,10],"mymirror":10,"myrepo":10,"n":7,"name":[3,5,10],"near":3,"necessari":7,"need":[1,5,7,8,9,10],"network":[7,10],"network_config":10,"never":7,"new":[2,6,7],"next":5,"no_pkg_lookup":10,"none":5,"normal":10,"note":3,"noth":7,"notif":6,"now":5,"ntp":[7,10],"null":[3,10],"number":10,"nvidia":9,"nvme":5,"nvme0n1":5,"nvme0n1p1":5,"nvram":10,"obj_id":[3,4,10],"object":5,"offer":3,"offici":[7,10,11],"offlin":10,"often":7,"old":7,"on_":1,"on_pacstrap":1,"one":[3,5,7,10],"onli":[3,7,8,10,11],"onlin":10,"only_hdd":10,"oper":[7,10],"option":[2,7],"optional_repositori":10,"order":[3,8,9],"org":[7,10],"os":10,"others":6,"otherwis":10,"outdat":7,"output":[8,10],"overal":[3,10],"overlap":9,"p":7,"packag":[1,8,9,10,11],"package1":10,"package2":10,"pacman":[1,3,7,9,10],"pager":7,"parallel":10,"paramet":[3,5,9,10],"part":[3,5],"parti":6,"partial":9,"partit":[4,5,10],"partition_info":5,"partitionflag":5,"partitiontyp":5,"partn":5,"partuuid":5,"pass":8,"password":[8,10],"password_hash":10,"paste":8,"path":[1,5,10,11],"pc801":5,"perform":[0,3,7,10],"perman":[3,10],"pgp":7,"phisch":[1,7],"pip":11,"pipewir":10,"pkg":[3,7],"pkgbuild":10,"place":5,"placement":5,"platform":7,"pleas":[3,7,8],"pledg":8,"plugin":[7,9],"point":1,"popul":7,"posit":3,"posixpath":5,"post":[2,6,8,10],"potenti":3,"pprint":5,"pr":[1,7],"pre":[9,10],"pre_mounted_config":3,"primari":[3,5,10],"print":[5,8],"prior":5,"priorit":7,"privileg":[5,10],"proceed":10,"process":6,"profil":[5,10],"profile_config":10,"program":10,"project":[7,11],"proper":7,"properti":7,"proprietari":9,"provid":[3,10],"public":8,"pulseaudio":10,"put":7,"py":[5,7,10],"pypa":11,"pypart":3,"pypi":9,"python":[7,9],"queri":1,"question":[8,10],"quick":[8,10],"quirk":7,"raid":3,"raw":[7,8],"re":[1,10],"reach":7,"reachabl":10,"read":10,"read_on":5,"readabl":10,"realli":7,"reason":7,"recommend":10,"refer":[1,4,5,7,10],"regular":10,"relat":[0,7],"releas":[6,7],"relev":3,"reli":3,"reliabl":7,"remot":[1,10],"remov":10,"replac":1,"repo":[5,10],"report":[3,9],"repositori":[2,10,11],"request":7,"requir":[1,3,5,7,10,11],"requisit":9,"resolv":1,"respect":[6,7],"restart":7,"result":[1,7],"rf":7,"right":[5,7,10],"rm":7,"role":6,"root":[5,7,10],"root_enc_password":10,"rs":8,"rt":10,"rule":6,"run":[1,2,3,5,7],"s":[3,5,6,7,9,10,11],"safe":[8,10],"said":3,"sake":11,"sane":[3,7],"save":10,"save_config":10,"scars":1,"scope":7,"script":[7,9,10,11],"scroll":10,"sda":[3,10],"sda1":3,"sda2":3,"sda3":3,"search":1,"second":1,"secretsanta2022":10,"section":[5,10],"sector":[3,5,10],"sector_s":[3,5,10],"sectors":5,"secur":8,"see":[6,7,10],"select":[3,7,10],"sens":6,"sensit":[8,10],"separ":10,"sequenti":9,"server":[6,7,8],"servic":7,"set":[2,3,7,10],"setup":[1,3,7,10],"sever":10,"share":8,"shareabl":8,"ship":[10,11],"show":7,"sign_check":10,"sign_opt":10,"signatur":7,"silent":[3,10],"similar":3,"simpl":5,"simplest":1,"simpli":11,"simplic":11,"simul":10,"sinc":10,"size":[3,5],"sk":5,"skip":7,"slight":3,"slow":7,"slowli":7,"small":7,"solv":7,"someth":5,"sometim":7,"sourc":[1,5,7,9,10],"specif":[1,3,7],"spirit":7,"stage":3,"standard":10,"start":[3,5,7,10],"state":1,"status":[3,10],"step":[8,9,10,11],"stiff":5,"store":[1,8],"str":[3,10],"strap":[1,8],"string":10,"struct":3,"subject":5,"submit":8,"subsequ":7,"substat":7,"subvolum":3,"success":5,"sudo":10,"suit":10,"suppli":3,"support":[3,5,7,9,10],"sure":10,"swap":10,"sy":7,"sync":9,"syntax":10,"sys_enc":10,"sys_lang":10,"system":[1,2,3,9,10],"systemctl":7,"systemd":[7,10],"t":[5,9],"tabl":10,"take":[2,10],"taken":[8,10],"tar":7,"target":1,"task":9,"tend":7,"test":10,"test_instal":5,"thank":9,"theori":7,"therefor":5,"thing":[3,6],"three":3,"thus":3,"ticket":8,"time":9,"timedatectl":7,"timer":7,"timesyncd":7,"timezon":10,"tool":[1,9],"top":[4,10],"topic":6,"topolog":7,"torx":[1,7],"total_s":[3,5,10],"toward":7,"tracker":3,"translat":3,"transpar":9,"treat":6,"tri":[7,8],"true":[3,10],"trust":7,"trustal":10,"tui":[9,10],"two":[1,3,10],"txt":8,"type":[3,5,9,10],"uefi":10,"uid":4,"uki":10,"undecid":1,"unifi":10,"unit":[3,5,10],"unknown":7,"unsupport":7,"updat":7,"upload":8,"upstream":7,"url":[7,8],"us":10,"usag":7,"use":[1,3,5,7,8,9,10],"user":[3,4,10],"user_configur":8,"user_credenti":8,"user_disk_layout":8,"usernam":[8,10],"usr":7,"usual":7,"utc":10,"utf":10,"utmost":8,"uuid":5,"val":3,"valid":7,"valu":[3,5,7,10],"var":[3,7,8,9],"various":10,"ve":5,"verif":6,"verifi":[6,7],"version":10,"via":1,"wait":9,"want":[6,7,11],"way":[1,5,7,8,10],"welcom":[1,7],"well":[6,10,11],"whatev":10,"whl":11,"widen":1,"wifi":10,"wiki":3,"will":[0,1,2,3,5,7,10,11],"wipe":[3,10],"wish":5,"within":5,"without":10,"wkd":9,"won":5,"work":[3,5,7,9],"workaround":7,"worldwid":10,"wrapper":9,"write":[6,9],"written":1,"wrong":9,"x86_64":7,"xz":7,"y":7,"yes":[3,10],"zen":10,"zfs":7,"zstd":3},"titles":["archinstall.Installer","Python Plugins","Custom Commands","Disk Configuration","Disk Encryption","Python module","Discord","Known Issues","Report Issues & Bugs","archinstall Documentation","Guided installation","Python library"],"titleterms":{"32bit":7,"How":1,"What":1,"api":9,"arch":7,"archinstal":[0,9],"archlinux":7,"arm":7,"aur":7,"best":3,"btrfs":3,"bug":8,"code":11,"command":2,"complet":7,"config":10,"configur":3,"cpu":7,"creat":5,"cred":10,"custom":2,"date":7,"discord":6,"discoveri":1,"disk":[3,4],"document":9,"doe":1,"driver":7,"effort":3,"encrypt":4,"error":7,"exampl":10,"ext4":3,"fat32":3,"file":8,"get":9,"guid":10,"help":9,"instal":[0,10,11],"issu":[7,8],"json":[3,10],"keyr":7,"known":7,"leav":3,"librari":[9,11],"linux":7,"log":8,"manual":3,"miss":7,"modul":5,"nvidia":7,"option":[3,10],"packag":7,"pacman":11,"paramet":1,"partit":3,"plugin":1,"pre":5,"proprietari":7,"pypi":11,"python":[1,5,11],"refer":9,"report":8,"requisit":5,"run":[9,10],"s":1,"script":5,"sourc":11,"support":1,"sync":7,"time":7,"type":7,"url":10,"usag":10,"use":11,"wait":7,"wkd":7,"work":1,"write":1}}) \ No newline at end of file