| index : archinstall32 | |
| Archlinux32 installer | gitolite user |
| summaryrefslogtreecommitdiff |
| -rw-r--r-- | docs/help/discord.rst | 2 | ||||
| -rw-r--r-- | docs/help/issues.rst | 23 | ||||
| -rw-r--r-- | docs/index.rst | 2 | ||||
| -rw-r--r-- | docs/installing/guided.rst | 165 |
diff --git a/docs/help/discord.rst b/docs/help/discord.rst index 996f721c..609fbecb 100644 --- a/docs/help/discord.rst +++ b/docs/help/discord.rst @@ -5,7 +5,7 @@ Discord There's a discord channel which is frequent by some `contributors <https://github.com/Torxed/archinstall/graphs/contributors>`_. -To join the server, head over to `discord.com/archinstall <https://discord.gg/cqXU88y>`_'s server and join in. +To join the server, head over to `https://discord.gg/cqXU88y <https://discord.gg/cqXU88y>`_'s server and join in. There's not many rules other than common sense and treat others with respect. There's the `@Party Animals` role if you want notifications of new releases which is posted in the `#Release Party` channel. diff --git a/docs/help/issues.rst b/docs/help/issues.rst index 594cc77a..f29b18cc 100644 --- a/docs/help/issues.rst +++ b/docs/help/issues.rst @@ -1,9 +1,9 @@ .. _help.issues: -Issue tracker -============= +Issue tracker & bugs +==================== -Issues should be reported over at `GitHub/issues <https://github.com/Torxed/archinstall/issues>`_. +Issues and bugs should be reported over at `https://github.com/Torxed/archinstall/issues <https://github.com/Torxed/archinstall/issues>`_. General questions, enhancements and security issues can be reported over there too. For quick issues or if you need help, head over the to the Discord server which has a help channel. @@ -11,20 +11,11 @@ For quick issues or if you need help, head over the to the Discord server which Submitting a help ticket ======================== -When submitting a help ticket, please include the *install-session_\*.log* found under *~/.cache/archinstall/* on the installation medium. +| 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 was strapped in. -.. code::bash - - cd ~/.cache/archinstall - . - ├── install-session_2020-11-08_10-43-50.665316.log - └── workers - ├── 1edc2abd08261603fb78a1f6083dc74654ea6625d167744221f6bd3dec4bcd5b - ├── a7c8c2ceea27df2b483c493995556c86bc3e4a1befd0f6709ef6a56ff91d23f4 - └── fadaf96c1164684cc16b374f703f7d3b959545e1ec1fb5471ace9835bf105752 - -| You can submit the *install-session_2020-11-08_10-43-50.665316.log* in this example to the support personel. -| They might ask you for individual worker files as well, they contain the raw output from the individual commands executed such *pacman -S ...* etc. +| There are additional worker files, these worker files contain individual command input and output. +| These worker files are located in :code:`~/.cache/archinstall/` and does not need to be submitted by default when submitting issues. .. warning:: diff --git a/docs/index.rst b/docs/index.rst index dadc9dbe..c03cc451 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -4,7 +4,7 @@ python-archinstall Documentation | **python-archinstall** *(or, archinstall for short)* is a helper library to install Arch Linux and manage services, packages and other things. | It comes packaged with different pre-configured installers, such as the `installing.guided`_ installer. | -| Here's a `demo <https://www.youtube.com/watch?v=9Xt7X_Iqg6E>`_ using the guided installer. +| A demo can be viewed here: `https://www.youtube.com/watch?v=9Xt7X_Iqg6E <https://www.youtube.com/watch?v=9Xt7X_Iqg6E>`_ which uses the default guided installer. .. warning:: This installer currently requires that your machine has EFI-mode enabled. diff --git a/docs/installing/guided.rst b/docs/installing/guided.rst index d09a9622..92324589 100644 --- a/docs/installing/guided.rst +++ b/docs/installing/guided.rst @@ -3,107 +3,172 @@ Guided installation =================== -This is the installer you'll encounter on the *(currently)* unofficial Arch Linux Archinstall ISO found on `archlinux.life <https://archlinux.life>`_. +This is the default scripted installation you'll encounter on the official Arch Linux Archinstall package as well as the unofficial ISO found on `https://archlinux.life <https://archlinux.life>`_. It will guide your through a very basic installation of Arch Linux. -You'll obviously need a physical machine or a virtual machine and have a basic understanding of how ISO-files work, where and how to mount them in order to boot the installer. +The installer has two pre-requisits: -It runs you through a set of questions in order to determine what the system should look like. Then the guided installer performs the required installation steps for you. Some additional steps might show up depending on your chosen input at some of the steps - those steps should be self explanatory and won't be covered here. + * A Physical or Virtual machine to install on + * An active internet connection prior to running archinstall + +.. warning:: + A basic understanding of how machines, ISO-files and command lines are needed. + Please read the official Arch Linux Wiki *(`https://wiki.archlinux.org/ <https://wiki.archlinux.org/>`_ to learn more)* .. note:: There are some limitations with the installer, such as that it will not configure WiFi during the installation procedure. And it will not perform a post-installation network configuration either. So you need to read up on `Arch Linux networking <https://wiki.archlinux.org/index.php/Network_configuration>`_ to get that to work. -Features --------- +Running the guided installation +------------------------------- + +.. note:: + Due to the package being quite new, it might be required to update the local package list before installing or continuing. Partial upgrades can cause issues, but the lack of dependencies should make this perfectly safe: + + .. code::bash + # pacman -Syy + +To install archinstall and subsequently the guided installer, simply do the following: + +.. code::bash + # pacman -S python-archinstall + +And to run it, execute archinstall as a Python module: + +.. code::bash + # python -m archinstall guided -The guided installer currently supports: +| The guided parameter is optional as it's the default behavior. +| But this will start the process of guiding you through a installation of a quite minimal Arch Linux experience. - * *(optional)* Setting up disk encryption - * *(optional)* Installing some simple desktop environments - * Choosing between a super-user or root based user setup +Description individual steps +============================ -Installation steps +Below is a description of each individual steps in order. + +keyboard languages ------------------ -The steps are ever so changing between versions. -But currently the steps are *(in order and explained briefly)* +Default is :code:`us`. -Locale -^^^^^^ +| A short list of the most common layouts are presented. +| Entering :code:`?` and pressing enter enables a search mode where additional keyboard layouts can be found. -Asks what locale you want. This configures your keyboard layout both during the installation and mostly in the installed system as well. +In search mode, you'll find things like: -Mirrors -^^^^^^^ + * :code:`sv-latin1` for swedish layouts -Next step is to select where you want to download packages from. -Selecting a mirror-region will greatly increase speeds of the installation. +Mirror region selection +----------------------- -.. note:: - The step is **optional**, and Arch Linux have built-in tools to attempt to improve the mirror-order during the installation. It does behave slightly unpredictable in some regions, so selecting it manually is recommended for this installer. +Default is :code:`auto detect best mirror` + +| Leaving this blank should enable the most appropriate mirror for you. +| But if you want to override and use only one selected region, you can enter one in this step. -Harddrive -^^^^^^^^^ +As an example: -The next step is to choose which medium to install to. -There are some limitations on what mediums the installer can detect and install on. -But for the most part, the following are supported: + * :code:`Sweden` *(wich a capital :code:`S`)* will only use mirrors from Sweden. + +Selection of drive +------------------ - * IDE and SATA drives - * NVMe and similar devices - * loopback devices +There is no default for this step and it's a required step. + +.. warning:: + | The selected device will be wiped completely! + | + | Make sure you select a drive that will be used only by Arch Linux. + | *(Future versions of archinstall will support multiboot on the same drive and more complex partition setups)* + +Select the appropriate drive by selecting it by number or full path. Disk encryption -^^^^^^^^^^^^^^^ +--------------- -Selecting a disk encryption password enables disk encryption for the installation. +Selecting a disk encryption password enables disk encryption for the OS partition. .. note:: - This step is highly recommended for most users, skipping this step comes with some risk so read up on why you would want to skip this before deciding to opt-out. + This step is highly recommended for most users, skipping this step comes with some risk and you are obligated to read up on why you would want to skip encryption before deciding to opt-out. .. warning:: - This step does require at least 1GB of free RAM during boot in order to boot at all. Keep this in mind when creating virtual machines. + This step does require at least 1GB of free RAM during boot in order to boot at all. Keep this in mind when creating virtual machines. It also only encrypts the OS partition - not the boot partition *(it's not full disk encryption)*. Hostname -^^^^^^^^ +-------- + +Default is :code:`Archinstall` The hostname in which the machine will identify itself on the local network. This step is optional, but a default hostname of `Archinstall` will be set if none is selected. Root password -^^^^^^^^^^^^^ +------------- -.. note:: - This step is optional and **it's recommended to skip** this step. +.. warning:: + | Setting a root password disables sudo permissions for additional users. + | It's there for **recommended to skip this step**! -This gives you the option to re-enable the `root` account on the machine. By default, the `root` account on Arch Linux is disabled and does not contain a password. +This gives you the option to re-enable the :code:`root` account on the machine. By default, the :code:`root` account on Arch Linux is disabled and does not contain a password. -Instead, you're recommended in the next step to set up a super-user. +You are instead recommended to skip to the next step without any input. -Super-user -^^^^^^^^^^ +Super User (sudo) +----------------- -.. note:: - This step only applies if you correctly skipped the previous step :ref:`root_password`_ which makes this step mandatory. +.. warning:: + This step only applies if you correctly skipped the previous step :ref:`root_password`_ which also makes this step mandatory. If the previous step was skipped, and only if it is skipped. -This step enables you to create a `sudo` enabled user with a password. +This step enables you to create a :code:`sudo` enabled user with a password. -The sudo permission grants `root`-like privileges to the account but is less prone to guessing attacks and other security enhancing measures. You are also less likely to mess up system critical things by operating in normal user-mode and calling `sudo` to gain temporary administrative privileges. +.. note:: + The sudo permission grants :code:`root`-like privileges to the account but is less prone to for instance guessing admin account attacks. You are also less likely to mess up system critical things by operating in normal user-mode and calling `sudo` to gain temporary administrative privileges. Pre-programmed profiles -^^^^^^^^^^^^^^^^^^^^^^^ +----------------------- -You can optionally choose to install a pre-programmed profile. These profiles might make it easier for new users or beginners to achieve a desktop environment as an example. +You can optionally choose to install a pre-programmed profile. These profiles might make it easier for new users or beginners to achieve a traditional desktop environment as an example. There is a list of profiles to choose from. If you are unsure of what any of these are, research the names that show up to understand what they are before you choose one. +.. note:: + | Some profiles might have sub-dependencies that will ask you to select additional profiles. + | For instance the :code:`desktop` profile will create a secondary menu to select a graphical driver. That graphical driver might have additional dependencies if there are multiple driver vendors. + | + | Simply follow the instructions on the screen to navigate through them. + Additional packages -^^^^^^^^^^^^^^^^^^^ +------------------- + +Some additional packages can be installed if need be. This step allows you to list *(space separated)* officially supported packages from the package database at `https://archlinux.org/packages/ <https://archlinux.org/packages/>`_. + + +Network configuration +--------------------- + +| In this step is optional and allows for some basic configuration of your network. +| There are two main options and two sub-options, the two main ones are: + + * Copy existing network configuration from the ISO you're working on + * Select **one** network interface to configure + +| If copying existing configuration is chosen, no further configuration is needed. +| The installer will copy any wireless *(based on :code:`iwd`)* configurations and :code:`systemd-networkd` configuration set up by the user or the default system configuration. + +| If a interface was selected instead, a secondary option will be presented, allowing you to choose between two options: + + * Automatic DHCP configuration of IP, DNS and Gateway + * Static IP configuration that further will ask some mandatory questions + +Configuration verification +-------------------------- + +| Before the installer continues, and this is only valid for the **guided installation**. +| The chosen configuration will be printed on the screen and you have the option to verify it. -Some additional packages can be installed if need be. This step allows you to list *(space separated)* officially supported packages from the `package database <https://archlinux.org/packages/>`_. +After which you can press :code:`Enter` can be pressed in order to start the formatting and installation process. .. warning:: - When selecting *(or skipping)* this step. The installation will begin and your selected hard drive will be wiped after a 5 second countdown. + After a 5 second countdown, the selected drive will be permanently erased and all data will be lost. Post installation ----------------- |