Just another guided/automated Arch Linux installer with a twist. The installer also doubles as a python library to install Arch Linux and manage services, packages, and other things inside the installed system (Usually from a live medium or from an existing installation).
- archinstall discord server
- archinstall #archinstall:matrix.org Matrix channel
- archinstall #archinstall@irc.libera.chat:6697
- archinstall documentation
Tip
In the ISO you are root by default. Use sudo if running from an existing system.
pacman-key --init
pacman -Sy archinstall
archinstallAlternative ways to install are git clone the repository (and is better since you get the latest code regardless of build date)
Upgrading archinstall on the ISO needs to be done via a full system upgrade using
pacman -SyuNote
The ISO has limited cow_spacesize (256M by default).
Optionally, if you need space in the temporary environment, simply: mount -o remount,size=1G /run/archiso/cowspace
Running the guided installer
Assuming you are on an Arch Linux live-ISO or installed via pip, archinstall will use the guided script by default
archinstallsimilar goes for running the guided installer using git
git clone https://github.com/archlinux/archinstall
cd archinstall
python -m archinstall $@To run alternative scripts using the --script parameter
archinstall --script <name>
Some additional options that most users do not need are hidden behind the --advanced flag and all options/args can be consulted through -h or --help.
archinstall can be run with a JSON configuration file. There are 2 different configuration files to consider,
the user_configuration.json contains all general installation configuration, whereas the user_credentials.json
contains the sensitive user configuration such as user password, root password, and encryption password.
An example of the user configuration file can be found here configuration file and an example of the credentials configuration here credentials file.
HINT: The configuration files can be auto-generated by starting archinstall, configuring all desired menu
points and then going to Save configuration.
To load the configuration file into archinstall run the following command
archinstall --config <path to user config file or URL> --creds <path to user credentials config file or URL>By default, all user account credentials are hashed with yescrypt and only the hash is stored in the saved user_credentials.json file.
This is not possible for disk encryption password which needs to be stored in plaintext to be able to apply it.
However, when selecting to save configuration files, archinstall will prompt for the option to encrypt the user_credentials.json file content.
A prompt will require to enter a encryption password to encrypt the file. When providing an encrypted user_configuration.json as a argument with --creds <user_credentials.json>
there are multiple ways to provide the decryption key:
- Provide the decryption key via the command line argument
--creds-decryption-key <password> - Store the encryption key in the environment variable
ARCHINSTALL_CREDS_DECRYPTION_KEYwhich will be read automatically - If none of the above is provided a prompt will be shown to enter the decryption key manually
If you come across any issues, kindly submit your issue here on GitHub or post your query in the discord help channel.
When submitting an issue, please:
- Provide the stacktrace of the output if applicable
- Attach the
/var/log/archinstall/install.logto the issue ticket. This helps us help you!- To upload the log from the ISO image and get a shareable URL, run
archinstall share-log
- To upload the log from the ISO image and get a shareable URL, run
Archinstall is available in different languages which have been contributed and are maintained by the community. The language can be switched inside the installer (first menu entry). Bear in mind that not all languages provide full translations as we rely on contributors to do the translations. Each language has an indicator that shows how much has been translated.
Any contributions to the translations are more than welcome, to get started please follow the guide
The ISO does not ship with all fonts needed for different languages. Fonts that use a different character set than Latin will not be displayed correctly. If those languages want to be selected then a proper font has to be set manually in the console.
All available console fonts can be found in /usr/share/kbd/consolefonts and set with setfont LatGrkCyr-8x16.
For an example of a fully scripted, interactive installation please refer to the example interactive_installation.py
To create your own ISO with this script in it: Follow ArchISO's guide on creating your own ISO.
