Send patches - preferably formatted by git format-patch - to patches at archlinux32 dot org.
summaryrefslogtreecommitdiff
path: root/examples
diff options
context:
space:
mode:
Diffstat (limited to 'examples')
-rw-r--r--examples/__init__.py0
-rw-r--r--examples/config-sample.json35
-rw-r--r--examples/custom-command-sample.json36
-rw-r--r--examples/guided.py133
-rw-r--r--examples/minimal.py26
-rw-r--r--examples/unattended.py7
6 files changed, 171 insertions, 66 deletions
diff --git a/examples/__init__.py b/examples/__init__.py
new file mode 100644
index 00000000..e69de29b
--- /dev/null
+++ b/examples/__init__.py
diff --git a/examples/config-sample.json b/examples/config-sample.json
new file mode 100644
index 00000000..55bdf04b
--- /dev/null
+++ b/examples/config-sample.json
@@ -0,0 +1,35 @@
+{
+ "!root-password": "<root_password>",
+ "audio": null,
+ "bootloader": "systemd-bootctl",
+ "filesystem": "btrfs",
+ "harddrive": {
+ "path": "/dev/sda"
+ },
+ "hostname": "box",
+ "kernels": [
+ "linux"
+ ],
+ "keyboard-language": "us",
+ "mirror-region": {
+ "Worldwide": {
+ "https://mirror.rackspace.com/archlinux/$repo/os/$arch": true
+ }
+ },
+ "nic": {
+ "NetworkManager": true
+ },
+ "packages": [],
+ "profile": null,
+ "superusers": {
+ "<username>": {
+ "!password": "<password>"
+ }
+ },
+ "timezone": "UTC",
+ "users": {
+ "<username>": {
+ "!password": "<password>"
+ }
+ }
+} \ No newline at end of file
diff --git a/examples/custom-command-sample.json b/examples/custom-command-sample.json
new file mode 100644
index 00000000..0518d3db
--- /dev/null
+++ b/examples/custom-command-sample.json
@@ -0,0 +1,36 @@
+{
+ "audio": "pipewire",
+ "bootloader": "systemd-bootctl",
+ "custom-commands": [
+ "cd /home/devel; git clone https://aur.archlinux.org/paru.git",
+ "chown -R devel:devel /home/devel/paru",
+ "usermod -aG docker devel"
+ ],
+ "!encryption-password": "supersecret",
+ "filesystem": "btrfs",
+ "harddrive": {
+ "path": "/dev/nvme0n1"
+ },
+ "hostname": "development-box",
+ "kernels": [
+ "linux"
+ ],
+ "keyboard-language": "us",
+ "mirror-region": {
+ "Worldwide": {
+ "https://mirror.rackspace.com/archlinux/$repo/os/$arch": true
+ }
+ },
+ "nic": {
+ "NetworkManager": true
+ },
+ "packages": ["docker", "git", "wget", "zsh"],
+ "profile": "gnome",
+ "superusers": {
+ "devel": {
+ "!password": "devel"
+ }
+ },
+ "timezone": "US/Eastern",
+ "users": {}
+}
diff --git a/examples/guided.py b/examples/guided.py
index 3f854f4c..1e370e21 100644
--- a/examples/guided.py
+++ b/examples/guided.py
@@ -1,6 +1,12 @@
-import getpass, time, json, os, logging
+import json
+import logging
+import os
+import time
+
import archinstall
-from archinstall.lib.hardware import hasUEFI
+from archinstall.lib.general import run_custom_user_commands
+from archinstall.lib.hardware import has_uefi
+from archinstall.lib.networking import check_mirror_reachable
from archinstall.lib.profiles import Profile
if archinstall.arguments.get('help'):
@@ -10,11 +16,12 @@ if archinstall.arguments.get('help'):
# For support reasons, we'll log the disk layout pre installation to match against post-installation layout
archinstall.log(f"Disk states before installing: {archinstall.disk_layouts()}", level=logging.DEBUG)
+
def ask_user_questions():
"""
- First, we'll ask the user for a bunch of user input.
- Not until we're satisfied with what we want to install
- will we continue with the actual installation steps.
+ First, we'll ask the user for a bunch of user input.
+ Not until we're satisfied with what we want to install
+ will we continue with the actual installation steps.
"""
if not archinstall.arguments.get('keyboard-layout', None):
while True:
@@ -41,8 +48,7 @@ def ask_user_questions():
archinstall.log(e, fg="red")
else:
selected_region = archinstall.arguments['mirror-region']
- archinstall.arguments['mirror-region'] = {selected_region : archinstall.list_mirrors()[selected_region]}
-
+ archinstall.arguments['mirror-region'] = {selected_region: archinstall.list_mirrors()[selected_region]}
# Ask which harddrives/block-devices we will install to
# and convert them into archinstall.BlockDevice() objects.
@@ -99,23 +105,20 @@ def ask_user_questions():
if not archinstall.arguments.get('profile', None):
archinstall.arguments['profile'] = archinstall.select_profile(archinstall.list_profiles(filter_top_level_profiles=True))
else:
- archinstall.arguments['profile'] = archinstall.list_profiles()[archinstall.arguments['profile']]
+ archinstall.arguments['profile'] = Profile(installer=None, path=archinstall.arguments['profile'])
# Check the potentially selected profiles preparations to get early checks if some additional questions are needed.
if archinstall.arguments['profile'] and archinstall.arguments['profile'].has_prep_function():
with archinstall.arguments['profile'].load_instructions(namespace=f"{archinstall.arguments['profile'].namespace}.py") as imported:
if not imported._prep_function():
- archinstall.log(
- ' * Profile\'s preparation requirements was not fulfilled.',
- fg='red'
- )
+ archinstall.log(' * Profile\'s preparation requirements was not fulfilled.', fg='red')
exit(1)
# Ask about audio server selection if one is not already set
if not archinstall.arguments.get('audio', None):
- # only ask for audio server selection on a desktop profile
+ # only ask for audio server selection on a desktop profile
if str(archinstall.arguments['profile']) == 'Profile(desktop)':
archinstall.arguments['audio'] = archinstall.ask_for_audio_selection()
else:
@@ -140,12 +143,12 @@ def ask_user_questions():
if len(archinstall.arguments['packages']):
# Verify packages that were given
try:
- archinstall.log(f"Verifying that additional packages exist (this might take a few seconds)")
+ archinstall.log("Verifying that additional packages exist (this might take a few seconds)")
archinstall.validate_package_list(archinstall.arguments['packages'])
break
except archinstall.RequirementError as e:
archinstall.log(e, fg='red')
- archinstall.arguments['packages'] = None # Clear the packages to trigger a new input question
+ archinstall.arguments['packages'] = None # Clear the packages to trigger a new input question
else:
# no additional packages were selected, which we'll allow
break
@@ -154,7 +157,7 @@ def ask_user_questions():
if not archinstall.arguments.get('nic', None):
archinstall.arguments['nic'] = archinstall.ask_to_configure_network()
if not archinstall.arguments['nic']:
- archinstall.log(f"No network configuration was selected. Network is going to be unavailable until configured manually!", fg="yellow")
+ archinstall.log("No network configuration was selected. Network is going to be unavailable until configured manually!", fg="yellow")
if not archinstall.arguments.get('timezone', None):
archinstall.arguments['timezone'] = archinstall.ask_for_a_timezone()
@@ -167,7 +170,8 @@ def perform_filesystem_operations():
archinstall.log(json.dumps(archinstall.arguments, indent=4, sort_keys=True, cls=archinstall.JSON), level=logging.INFO)
print()
- input('Press Enter to continue.')
+ if not archinstall.arguments.get('silent'):
+ input('Press Enter to continue.')
"""
Issue a final warning before we continue with something un-revertable.
@@ -183,19 +187,18 @@ def perform_filesystem_operations():
Once that's done, we'll hand over to perform_installation()
"""
mode = archinstall.GPT
- if hasUEFI() is False:
+ if has_uefi() is False:
mode = archinstall.MBR
-
with archinstall.Filesystem(archinstall.arguments['harddrive'], mode) as fs:
# Wipe the entire drive if the disk flag `keep_partitions`is False.
if archinstall.arguments['harddrive'].keep_partitions is False:
fs.use_entire_disk(root_filesystem_type=archinstall.arguments.get('filesystem', 'btrfs'))
-
+
# Check if encryption is desired and mark the root partition as encrypted.
if archinstall.arguments.get('!encryption-password', None):
root_partition = fs.find_partition('/')
root_partition.encrypted = True
-
+
# After the disk is ready, iterate the partitions and check
# which ones are safe to format, and format those.
for partition in archinstall.arguments['harddrive']:
@@ -209,8 +212,6 @@ def perform_filesystem_operations():
partition.format()
else:
archinstall.log(f"Did not format {partition} because .safe_to_format() returned False or .allow_formatting was False.", level=logging.DEBUG)
- if hasUEFI():
- fs.find_partition('/boot').format('vfat')# we don't have a boot partition in bios mode
if archinstall.arguments.get('!encryption-password', None):
# First encrypt and unlock, then format the desired partition inside the encrypted part.
@@ -218,12 +219,15 @@ def perform_filesystem_operations():
# unlocks the drive so that it can be used as a normal block-device within archinstall.
with archinstall.luks2(fs.find_partition('/'), 'luksloop', archinstall.arguments.get('!encryption-password', None)) as unlocked_device:
unlocked_device.format(fs.find_partition('/').filesystem)
- unlocked_device.mount('/mnt')
+ unlocked_device.mount(archinstall.storage.get('MOUNT_POINT', '/mnt'))
else:
- fs.find_partition('/').format(fs.find_partition('/').filesystem)
- fs.find_partition('/').mount('/mnt')
- if hasUEFI():
- fs.find_partition('/boot').mount('/mnt/boot')
+ fs.find_partition('/').mount(archinstall.storage.get('MOUNT_POINT', '/mnt'))
+
+ if has_uefi():
+ fs.find_partition('/boot').mount(archinstall.storage.get('MOUNT_POINT', '/mnt') + '/boot')
+
+ perform_installation(archinstall.storage.get('MOUNT_POINT', '/mnt'))
+
def perform_installation(mountpoint):
"""
@@ -232,30 +236,29 @@ def perform_installation(mountpoint):
formatted and setup prior to entering this function.
"""
with archinstall.Installer(mountpoint, kernels=archinstall.arguments.get('kernels', 'linux')) as installation:
- ## if len(mirrors):
+ # if len(mirrors):
# Certain services might be running that affects the system during installation.
# Currently, only one such service is "reflector.service" which updates /etc/pacman.d/mirrorlist
# We need to wait for it before we continue since we opted in to use a custom mirror/region.
- installation.log(f'Waiting for automatic mirror selection (reflector) to complete.', level=logging.INFO)
+ installation.log('Waiting for automatic mirror selection (reflector) to complete.', level=logging.INFO)
while archinstall.service_state('reflector') not in ('dead', 'failed'):
time.sleep(1)
# Set mirrors used by pacstrap (outside of installation)
if archinstall.arguments.get('mirror-region', None):
- archinstall.use_mirrors(archinstall.arguments['mirror-region']) # Set the mirrors for the live medium
+ archinstall.use_mirrors(archinstall.arguments['mirror-region']) # Set the mirrors for the live medium
if installation.minimal_installation():
installation.set_hostname(archinstall.arguments['hostname'])
- if archinstall.arguments['mirror-region'].get("mirrors",{})!= None:
- installation.set_mirrors(archinstall.arguments['mirror-region']) # Set the mirrors in the installation medium
- if archinstall.arguments["bootloader"]=="grub-install" and hasUEFI()==True:
+ if archinstall.arguments['mirror-region'].get("mirrors", None) is not None:
+ installation.set_mirrors(archinstall.arguments['mirror-region']) # Set the mirrors in the installation medium
+ if archinstall.arguments["bootloader"] == "grub-install" and has_uefi():
installation.add_additional_packages("grub")
- installation.set_keyboard_language(archinstall.arguments['keyboard-language'])
installation.add_bootloader(archinstall.arguments["bootloader"])
# If user selected to copy the current ISO network configuration
# Perform a copy of the config
if archinstall.arguments.get('nic', {}) == 'Copy ISO network configuration to installation':
- installation.copy_ISO_network_config(enable_services=True) # Sources the ISO network configuration to the install medium.
- elif archinstall.arguments.get('nic', {}).get('NetworkManager',False):
+ installation.copy_iso_network_config(enable_services=True) # Sources the ISO network configuration to the install medium.
+ elif archinstall.arguments.get('nic', {}).get('NetworkManager', False):
installation.add_additional_packages("networkmanager")
installation.enable_service('NetworkManager.service')
# Otherwise, if a interface was selected, configure that interface
@@ -264,7 +267,7 @@ def perform_installation(mountpoint):
installation.enable_service('systemd-networkd')
installation.enable_service('systemd-resolved')
- if archinstall.arguments.get('audio', None) != None:
+ if archinstall.arguments.get('audio', None) is not None:
installation.log(f"This audio server will be used: {archinstall.arguments.get('audio', None)}", level=logging.INFO)
if archinstall.arguments.get('audio', None) == 'pipewire':
print('Installing pipewire ...')
@@ -275,7 +278,7 @@ def perform_installation(mountpoint):
installation.add_additional_packages("pulseaudio")
else:
installation.log("No audio server will be installed.", level=logging.INFO)
-
+
if archinstall.arguments.get('packages', None) and archinstall.arguments.get('packages', None)[0] != '':
installation.add_additional_packages(archinstall.arguments.get('packages', None))
@@ -288,31 +291,59 @@ def perform_installation(mountpoint):
for superuser, user_info in archinstall.arguments.get('superusers', {}).items():
installation.user_create(superuser, user_info["!password"], sudo=True)
- if (timezone := archinstall.arguments.get('timezone', None)):
+ if timezone := archinstall.arguments.get('timezone', None):
installation.set_timezone(timezone)
if (root_pw := archinstall.arguments.get('!root-password', None)) and len(root_pw):
installation.user_set_pw('root', root_pw)
+ # This step must be after profile installs to allow profiles to install language pre-requisits.
+ # After which, this step will set the language both for console and x11 if x11 was installed for instance.
+ installation.set_keyboard_language(archinstall.arguments['keyboard-language'])
+
if archinstall.arguments['profile'] and archinstall.arguments['profile'].has_post_install():
with archinstall.arguments['profile'].load_instructions(namespace=f"{archinstall.arguments['profile'].namespace}.py") as imported:
if not imported._post_install():
- archinstall.log(
- ' * Profile\'s post configuration requirements was not fulfilled.',
- fg='red'
- )
+ archinstall.log(' * Profile\'s post configuration requirements was not fulfilled.', fg='red')
exit(1)
+ # If the user provided custom commands to be run post-installation, execute them now.
+ if archinstall.arguments.get('custom-commands', None):
+ run_custom_user_commands(archinstall.arguments['custom-commands'], installation)
+
installation.log("For post-installation tips, see https://wiki.archlinux.org/index.php/Installation_guide#Post-installation", fg="yellow")
- choice = input("Would you like to chroot into the newly created installation and perform post-installation configuration? [Y/n] ")
- if choice.lower() in ("y", ""):
- try:
- installation.drop_to_shell()
- except:
- pass
+ if not archinstall.arguments.get('silent'):
+ choice = input("Would you like to chroot into the newly created installation and perform post-installation configuration? [Y/n] ")
+ if choice.lower() in ("y", ""):
+ try:
+ installation.drop_to_shell()
+ except:
+ pass
# For support reasons, we'll log the disk layout post installation (crash or no crash)
- archinstall.log(f"Disk states after installing: {archinstall.disk_layouts()}", level=archinstall.LOG_LEVELS.Debug)
+ archinstall.log(f"Disk states after installing: {archinstall.disk_layouts()}", level=logging.DEBUG)
+
+
+if not check_mirror_reachable():
+ log_file = os.path.join(archinstall.storage.get('LOG_PATH', None), archinstall.storage.get('LOG_FILE', None))
+ archinstall.log(f"Arch Linux mirrors are not reachable. Please check your internet connection and the log file '{log_file}'.", level=logging.INFO, fg="red")
+ exit(1)
+
+if archinstall.arguments.get('silent', None) is None:
+ ask_user_questions()
+else:
+ # Workarounds if config is loaded from a file
+ # The harddrive section should be moved to perform_installation_steps, where it's actually being performed
+ # Blockdevice object should be created in perform_installation_steps
+ # This needs to be done until then
+ archinstall.arguments['harddrive'] = archinstall.BlockDevice(path=archinstall.arguments['harddrive']['path'])
+ # Temporarily disabling keep_partitions if config file is loaded
+ archinstall.arguments['harddrive'].keep_partitions = False
+ # Temporary workaround to make Desktop Environments work
+ if archinstall.arguments.get('profile', None) is not None:
+ archinstall.arguments['profile'] = archinstall.Profile(None, archinstall.arguments.get('profile', None))
+ else:
+ archinstall.arguments['profile'] = None
ask_user_questions()
perform_filesystem_operations()
diff --git a/examples/minimal.py b/examples/minimal.py
index 98d9a6f0..5da6f0c1 100644
--- a/examples/minimal.py
+++ b/examples/minimal.py
@@ -1,18 +1,19 @@
import archinstall
# Select a harddrive and a disk password
-archinstall.log(f"Minimal only supports:")
-archinstall.log(f" * Being installed to a single disk")
+archinstall.log("Minimal only supports:")
+archinstall.log(" * Being installed to a single disk")
if archinstall.arguments.get('help', None):
- archinstall.log(f" - Optional disk encryption via --!encryption-password=<password>")
- archinstall.log(f" - Optional filesystem type via --filesystem=<fs type>")
- archinstall.log(f" - Optional systemd network via --network")
+ archinstall.log(" - Optional disk encryption via --!encryption-password=<password>")
+ archinstall.log(" - Optional filesystem type via --filesystem=<fs type>")
+ archinstall.log(" - Optional systemd network via --network")
archinstall.arguments['harddrive'] = archinstall.select_disk(archinstall.all_disks())
+
def install_on(mountpoint):
- # We kick off the installer by telling it where the
+ # We kick off the installer by telling it where the
with archinstall.Installer(mountpoint) as installation:
# Strap in the base system, add a boot loader and configure
# some other minor details as specified by this profile and user.
@@ -22,7 +23,7 @@ def install_on(mountpoint):
# Optionally enable networking:
if archinstall.arguments.get('network', None):
- installation.copy_ISO_network_config(enable_services=True)
+ installation.copy_iso_network_config(enable_services=True)
installation.add_additional_packages(['nano', 'wget', 'git'])
installation.install_profile('minimal')
@@ -32,13 +33,14 @@ def install_on(mountpoint):
# Once this is done, we output some useful information to the user
# And the installation is complete.
- archinstall.log(f"There are two new accounts in your installation after reboot:")
- archinstall.log(f" * root (password: airoot)")
- archinstall.log(f" * devel (password: devel)")
+ archinstall.log("There are two new accounts in your installation after reboot:")
+ archinstall.log(" * root (password: airoot)")
+ archinstall.log(" * devel (password: devel)")
+
if archinstall.arguments['harddrive']:
archinstall.arguments['harddrive'].keep_partitions = False
-
+
print(f" ! Formatting {archinstall.arguments['harddrive']} in ", end='')
archinstall.do_countdown()
@@ -68,4 +70,4 @@ if archinstall.arguments['harddrive']:
boot.mount('/mnt/boot')
-install_on('/mnt') \ No newline at end of file
+install_on('/mnt')
diff --git a/examples/unattended.py b/examples/unattended.py
index 679fbdf6..f1ed4c94 100644
--- a/examples/unattended.py
+++ b/examples/unattended.py
@@ -1,6 +1,7 @@
-import archinstall
import time
+import archinstall
+
archinstall.storage['UPSTREAM_URL'] = 'https://archlinux.life/profiles'
archinstall.storage['PROFILE_DB'] = 'index.json'
@@ -10,11 +11,11 @@ for name, info in archinstall.list_profiles().items():
# that fits the requirements for this machine specifically).
if info['tailored']:
print(f'Found a tailored profile for this machine called: "{name}".')
- print(f'Starting install in:')
+ print('Starting install in:')
for i in range(10, 0, -1):
print(f'{i}...')
time.sleep(1)
profile = archinstall.Profile(None, info['path'])
profile.install()
- break \ No newline at end of file
+ break