From e28ba953708cee089161a795fb3191cfd5c3d93a Mon Sep 17 00:00:00 2001 From: Anton Hvornum Date: Wed, 22 Nov 2023 22:45:25 +0100 Subject: Restoring back the docs with a commit, as I'm clearly incapable of grasping git's reset/revert features.. (#2249) --- docs/archinstall/Installer.rst | 11 + docs/archinstall/plugins.rst | 57 +++++ docs/cli_parameters/config/config_options.csv | 24 +++ docs/cli_parameters/config/custom_commands.rst | 22 ++ docs/cli_parameters/config/disk_config.rst | 245 +++++++++++++++++++++ docs/cli_parameters/config/disk_encryption.rst | 19 ++ docs/cli_parameters/config/manual_options.csv | 4 + docs/examples/python.rst | 96 +++++++++ docs/flowcharts/BlockDeviceSelection.svg | 3 + docs/flowcharts/DiskSelectionProcess.drawio | 1 + docs/help/discord.rst | 14 ++ docs/help/known_issues.rst | 103 +++++++++ docs/help/report_bug.rst | 33 +++ docs/index.rst | 46 +++- docs/installing/guided.rst | 287 +++++++++++++++++++++++++ docs/installing/python.rst | 59 +++++ 16 files changed, 1020 insertions(+), 4 deletions(-) create mode 100644 docs/archinstall/Installer.rst create mode 100644 docs/archinstall/plugins.rst create mode 100644 docs/cli_parameters/config/config_options.csv create mode 100644 docs/cli_parameters/config/custom_commands.rst create mode 100644 docs/cli_parameters/config/disk_config.rst create mode 100644 docs/cli_parameters/config/disk_encryption.rst create mode 100644 docs/cli_parameters/config/manual_options.csv create mode 100644 docs/examples/python.rst create mode 100644 docs/flowcharts/BlockDeviceSelection.svg create mode 100644 docs/flowcharts/DiskSelectionProcess.drawio create mode 100644 docs/help/discord.rst create mode 100644 docs/help/known_issues.rst create mode 100644 docs/help/report_bug.rst create mode 100644 docs/installing/guided.rst create mode 100644 docs/installing/python.rst diff --git a/docs/archinstall/Installer.rst b/docs/archinstall/Installer.rst new file mode 100644 index 00000000..d1bbaa7c --- /dev/null +++ b/docs/archinstall/Installer.rst @@ -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/docs/archinstall/plugins.rst b/docs/archinstall/plugins.rst new file mode 100644 index 00000000..898f9006 --- /dev/null +++ b/docs/archinstall/plugins.rst @@ -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 \ No newline at end of file diff --git a/docs/cli_parameters/config/config_options.csv b/docs/cli_parameters/config/config_options.csv new file mode 100644 index 00000000..1861b1e1 --- /dev/null +++ b/docs/cli_parameters/config/config_options.csv @@ -0,0 +1,24 @@ +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,`Systemd-boot `_!, `grub `_,Bootloader to be installed *(grub being mandatory on BIOS machines)*,Yes +debug,``true``!, ``false``,Enables debug output,No +disk_config,*Read more under* :ref:`disk config`,Contains the desired disk setup to be used during installation,No +disk_encryption,*Read more about under* :ref:`disk encryption`,Parameters for disk encryption applied ontop of ``disk_config``,No +hostname,``str``,A string definining 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* :ref:`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,[ !, !, ... ],A list of packages to install during installation,No +parallel downloads,0-∞,sets a given number of paralell 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 `_!, `swiss `_!, `unattended `_,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 \ No newline at end of file diff --git a/docs/cli_parameters/config/custom_commands.rst b/docs/cli_parameters/config/custom_commands.rst new file mode 100644 index 00000000..c1529020 --- /dev/null +++ b/docs/cli_parameters/config/custom_commands.rst @@ -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/ `_ \ No newline at end of file diff --git a/docs/cli_parameters/config/disk_config.rst b/docs/cli_parameters/config/disk_config.rst new file mode 100644 index 00000000..ed5f42c1 --- /dev/null +++ b/docs/cli_parameters/config/disk_config.rst @@ -0,0 +1,245 @@ +.. _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) + +Runing ``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": [ + { + "compress": false, + "mountpoint": "/", + "name": "@", + "nodatacow": false + }, + { + "compress": false, + "mountpoint": "/home", + "name": "@home", + "nodatacow": false + }, + { + "compress": false, + "mountpoint": "/var/log", + "name": "@log", + "nodatacow": false + }, + { + "compress": false, + "mountpoint": "/var/cache/pacman/pkg", + "name": "@pkg", + "nodatacow": false + }, + { + "compress": false, + "mountpoint": "/.snapshots", + "name": "@.snapshots", + "nodatacow": false + } + ], + "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/docs/cli_parameters/config/disk_encryption.rst b/docs/cli_parameters/config/disk_encryption.rst new file mode 100644 index 00000000..df2e2fa7 --- /dev/null +++ b/docs/cli_parameters/config/disk_encryption.rst @@ -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. \ No newline at end of file diff --git a/docs/cli_parameters/config/manual_options.csv b/docs/cli_parameters/config/manual_options.csv new file mode 100644 index 00000000..2fcc26f0 --- /dev/null +++ b/docs/cli_parameters/config/manual_options.csv @@ -0,0 +1,4 @@ +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 \ No newline at end of file diff --git a/docs/examples/python.rst b/docs/examples/python.rst new file mode 100644 index 00000000..7fb3f6c3 --- /dev/null +++ b/docs/examples/python.rst @@ -0,0 +1,96 @@ +.. _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 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 whtin ``archinstall``. + +.. code-block:: python + + import archinstall + + print(archinstall.disk.device_handler.devices) + +Now, go ahead and reference the :ref:`installing.python.manual` installation method. +After runnig ``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 \ No newline at end of file diff --git a/docs/flowcharts/BlockDeviceSelection.svg b/docs/flowcharts/BlockDeviceSelection.svg new file mode 100644 index 00000000..2d63f674 --- /dev/null +++ b/docs/flowcharts/BlockDeviceSelection.svg @@ -0,0 +1,3 @@ + + +
Select BlockDevices
Select BlockDevices
No
No
Yes
Yes
Empty Selection
Empty Selection
Yes / No
Yes / No
Encrypt Root
Encrypt Root
No
No
Yes
Yes
Multiple BD's
Multiple BD's
Select /boot, / and optional mounts
Select /boot, / and...
Yes
Yes
No
No
Contains Partitions
Contains Partitions
No
No
Yes
Yes
Old /boot has content
Old /boot has cont...
Select Root FIlesystem
Select Root FIlesyst...
Mount Partitions
Mount Partitions
Install on /mnt
Install on /mnt
Yes
Yes
Wipe /Boot
Wipe /Boot
Clear old
systemd-boot files
Clear old...Viewer does not support full SVG 1.1 \ No newline at end of file diff --git a/docs/flowcharts/DiskSelectionProcess.drawio b/docs/flowcharts/DiskSelectionProcess.drawio new file mode 100644 index 00000000..7c8a1fcb --- /dev/null +++ b/docs/flowcharts/DiskSelectionProcess.drawio @@ -0,0 +1 @@ +7VvZdqM4EP2anHlKDpsxPMZ20sl0kl7S05meNwVkYCIjt5C3+fqRjFgFNnbwksQv3a5CCKG6dWsROdP7o/knAsb+PXYhOtMUd36mD840TVUsi/3HNYtYY5tC4ZHAFYMyxWPwH0zuFNpJ4MKoMJBijGgwLiodHIbQoQUdIATPisOGGBWfOgYelBSPDkCy9ilwqR9rLa2b6W9g4PnJk1XTjq+MQDJYvEnkAxfPcir96kzvE4xp/Gs070PENy/Zl6fbxRO6ezE//fkt+g3+6n3+8fDzPJ7sepNb0lcgMKRbT/3y2bLtaXf4oFrf7ga/rYfB/dW5IV6NLpL9gi7bPiFiQn3s4RCgq0zbI3gSupDPqjIpG3OH8Vgo/4WULgQWwIRipvLpCImr7C3I4m8mKBedRPzFxUQYzAvSQkhDHNI+RpgsV6obpmF3BkwfUYJfYO5K17IuL3V+R4BQTt/T+vZlbzmve80upetxLznSmOggEEWBs5wUECoGKYmcDAtxyHcieoHU8cWAeCf59pWAt8ZqYlyEJ8SBK8bpwnkA8eCq+cwUmsynIR5BtoXsPgIRoMG0uDggnMtLx2UAYj8EhjaAqljkFKCJeNIjRNytNaWHsPMygNPAYXRQRt3MDyh8HIPlDswYExURwy0v4KSyl+t53EypYbj1E9/mo1NHVSS01gFiBYRqQLeZdaeQUDjP7b1soOSqKehG8K0lxFlGXmrCSH6OuAzl9SatpAhNMukDPrFGBUHskwzMhmSgKtVga50NKqEjs8GvCt8/IHbUA2HnbUScCpBp3mx4N50TtftTuRl3H7/9Y4fnmrGS0c6Vi65qCCw0Bp6Y7isOQpobgofDiC2mjMz0qduHLlMC69VoTPl7xCEswKEEXeLj0fOELa23JoAVQhJH1TUYBYjD7AaiKaSBAyrCHECBF3KMMHtCUh3r2COD0GOSmUk/lm7Bkru3H/7UbsP4Z7UQ/6rRXcNiCp9WU7YKhs6ETJdGkTOUgodvQXWbU1OdieE8oDnOZFJKmex3xphcSAhz2yBd4LpqSizxpiDEjFeVjVGZJ8Bq02sNw2y3koprQa5cqIZmv44QxVRGp+QvZskP4rWLu/Ll4f6YtSsza+iQxZg//Tsvn0/VQB1SOnrJvPahywHlSMqBd5nWJ02ztSlXZ13G9XqCaZUXKqGkSlA6VHmwx0j3YXBbPbCG7vbTnVJl8rqf8FY0g5Gm9AZ/yOg7Zfi7zvC1piFtdxm+Kpn9naTwbbt5coCzLjxZDfPhPbm9HGjSrjSb8HmZgvbTig6ELvsXj3nFD/jkI2ZdeupZN3dpQ99jlloJQLul1KJd723dS+tzw2N20srVqHKVuFVh8arucCGRy/K62qbFG7G0ah6VqTuSpftsv0AQ8q7aV5bGBpx6T7nY7olb7xxbLqbKzL1/GtjskOjgNGC1TQO5gxvdFj3Qo2gjVKfvbQX7nab0FWd5pYq98lCwXOQfvjJ4FQS140o6LAk5X5CbrwoUH/Cg5LBdhKHcqP64EQkQR6xU0/cYoAz14AHKOkWjlVSgNv02pemh2WaRh1EoWOQGjHkcinYRd1T5i4G0rRAfaynXtwhGi4jCkQSaU/eg7oxLb+rjO+seaHKFcmzpRFt5gAsiP11Wy0yQ7FrDD4iOJitI1p0/JuAtwNXV6RqHLgGgnA9sdiQkM0Cd3fO8sS8H3ucnqyvxlDPgbcjS7eWd/DMunuCNKvK57W0o2crSnnXTbGIrtwMt1yjZquCXzA70C0/tKN9hY5e21I0js6Xe1inxqbrbnsiblncJERwLkcv13VMwhrH/96q+PPq4Bd3OCKVUwXWMTjNG2VkFpx9dMve+2aN9Uqj+FNJUS3WEYRenqPkUsq16MHnP/LkGgoDwnIN3lUzEdrP3zGTT47/iwtA9F50mZqWKuHYipNazVaMBIRntEBITs78PjXGW/ZWtfvU/ \ No newline at end of file diff --git a/docs/help/discord.rst b/docs/help/discord.rst new file mode 100644 index 00000000..f0c7c279 --- /dev/null +++ b/docs/help/discord.rst @@ -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/cqXU88y `_ 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/docs/help/known_issues.rst b/docs/help/known_issues.rst new file mode 100644 index 00000000..2f1f62cb --- /dev/null +++ b/docs/help/known_issues.rst @@ -0,0 +1,103 @@ +.. _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. + +| A *"fix"* for this is mentioned in the issue above. +| That is to configure ``/etc/systemd/timesyncd.conf`` and restart ``systemd-timesyncd.service``. + +.. note:: + + A proposal to override the time sync check has been put up for discussion in `#2144`_. + +Missing Nvidia Proprietary Driver `#2002`_ +------------------------------------------ + +| In some instances, the nvidia driver might not have all the nessecary 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 have 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 a 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 betwene a sane ammount of ISO's. + +.. 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. + +.. _#2213: https://github.com/archlinux/archinstall/issues/2213 +.. _#2185: https://github.com/archlinux/archinstall/issues/2185 +.. _#2144: https://github.com/archlinux/archinstall/issues/2144 +.. _#2002: https://github.com/archlinux/archinstall/issues/2002 +.. _#1686: https://github.com/archlinux/archinstall/issues/1686 +.. _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 \ No newline at end of file diff --git a/docs/help/report_bug.rst b/docs/help/report_bug.rst new file mode 100644 index 00000000..bd0ac50a --- /dev/null +++ b/docs/help/report_bug.rst @@ -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 ``curl -F'file=@/var/log/archinstall/install.log' https://0x0.st``. + | 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/docs/index.rst b/docs/index.rst index b22e7c17..6a81bbb0 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,5 +1,43 @@ -.. raw:: html +archinstall Documentation +========================= - \ No newline at end of file +| **archinstall** is 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. +| +| A demo of the :ref:`guided` installer can be seen here: `https://www.youtube.com/watch?v=9Xt7X_Iqg6E `_. + +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/docs/installing/guided.rst b/docs/installing/guided.rst new file mode 100644 index 00000000..dcedfc10 --- /dev/null +++ b/docs/installing/guided.rst @@ -0,0 +1,287 @@ +.. _guided: + +Guided installation +=================== + +Archinstall ships with a pre-programmed `Guided Installer`_ guiding you through the mandatory steps as well as some optional configurations that can be done. + +.. note:: + + Other pre-programmed scripts can be invoked by executing :code:`archinstall