archiso with gnome and d-leatin1 keyboard
Go to file
nl6720 41d3d7d489
Add Joliet file system to the ISO
Joliet ensures correct file names capitalization on operating systems that support Joliet but not support Rock Ridge.
Implements https://gitlab.archlinux.org/archlinux/archiso/-/issues/45 .
2020-08-18 21:41:37 +03:00
archiso Add Joliet file system to the ISO 2020-08-18 21:41:37 +03:00
configs archiso/mkarchiso: create an empty /etc/machine-id 2020-08-18 21:27:52 +03:00
docs Using edk2-shell for UEFI shell 2020-05-30 19:30:52 +02:00
scripts scripts/run_archiso.sh: support booting the image as a hard disk or an optical disc 2020-08-18 21:21:23 +03:00
.editorconfig Add license and basic documentation 2020-07-29 14:27:48 +02:00
.gitattributes Add .gitignore and .gitattributes 2012-08-03 22:03:03 +02:00
.gitignore Add work and out directories to .gitignore 2020-07-11 16:31:18 +03:00
.gitlab-ci.yml Move shell script linting into a separate make target 2020-07-30 13:09:53 +03:00
AUTHORS.rst Add license and basic documentation 2020-07-29 14:27:48 +02:00
CONTRIBUTING.rst CONTRIBUTING.rst: use make lint to run shellcheck 2020-07-30 13:37:55 +03:00
LICENSE Add license and basic documentation 2020-07-29 14:27:48 +02:00
Makefile archiso/mkarchiso: start preparing a build_profile command 2020-08-17 14:22:36 +03:00
README.rst Deprecate build.sh scripts and old mkarchiso commands 2020-08-17 21:33:20 +03:00

=======
archiso
=======

The archiso project features scripts and configuration templates to build installation media (*.iso* images) for BIOS
and UEFI based systems on the x86_64 architecture.
Currently creating the images is only supported on Arch Linux.

Requirements
============

The following packages need to be installed to be able to create an image with the included scripts:

* arch-install-scripts
* dosfstools
* e2fsprogs
* libisoburn
* squashfs-tools

For running the images in a virtualized test environment the following packages are required:

* edk2-ovmf
* qemu

For linting the shell scripts the following package is required:

* shellcheck

Profiles
========

Archiso comes with two profiles: **baseline** and **releng**. While both can serve as starting points for creating
custom live media, **releng** is used to create the monthly installation medium.
They can be found below `configs/baseline/ <configs/baseline/>`_  and `configs/releng/ <configs/releng/>`_
(respectively). Both profiles are defined by files to be placed into overlays (e.g. *airootfs* -> *the image's /*).

Create images
=============

Usually the archiso tools are installed as a package. However, it is also possible to clone this repository and create
images without installing archiso system-wide.

As filesystems are created and various mount actions have to be done when creating an image, **root** is required to run
the scripts.

When archiso is installed system-wide and the modification of a profile is desired, it is necessary to copy it to a
writeable location, as */usr/share/archiso* is tracked by the package manager and only writeable by root (changes will
be lost on update).

The examples below will assume an unmodified profile in a system location (unless noted otherwise).

It is advised to check the help information of the **mkarchiso**:

  .. code:: bash

    mkarchiso -h

Create images with packaged archiso
-----------------------------------

  .. code:: bash

    mkarchiso -B path/to/profile -w path/to/work_dir -o path/to/out_dir build_profile

Create images with local clone
------------------------------

Clone this repository and run:

  .. code:: bash

    ./archiso/mkarchiso -B path/to/profile -w path/to/work_dir -o path/to/out_dir build_profile

Testing
=======

The convenience script **run_archiso** is provided to boot into the medium using qemu.
It is advised to read its help information:

  .. code:: bash

    run_archiso -h

Run the following to boot the iso using BIOS:

  .. code:: bash

    run_archiso -i path/to/an/arch.iso

Run the following to boot the iso using UEFI:

  .. code:: bash

    run_archiso -i path/to/an/arch.iso -u

The script can of course also be executed from this repository:


  .. code:: bash

    ./scripts/run_archiso.sh -i path/to/an/arch.iso

Installation
============

To install archiso system-wide use the included **Makefile**:

  .. code:: bash

    make install

Optionally install archiso's mkinitcpio hooks:

  .. code:: bash

    make install-initcpio

License
=======

Archiso is licensed under the terms of the **GPL-3.0-or-later** (see `LICENSE <LICENSE>`_).