README.rst 4.99 KB
Newer Older
1
2
3
4
=======
archiso
=======

5
The archiso project features scripts and configuration templates to build installation media (*.iso* images and
6
7
*.tar.gz* bootstrap images) as well as netboot artifacts for BIOS and UEFI based systems on the x86_64 architecture.
Currently creating the images is only supported on Arch Linux but may work on other operating systems as well.
8
9
10
11
12
13
14

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

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

* arch-install-scripts
15
* awk
16
17
* dosfstools
* e2fsprogs
18
19
20
21
* erofs-utils (optional)
* findutils
* gzip
* libarchive
22
* libisoburn
23
* mtools
24
* openssl
25
26
* pacman
* sed
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
* 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/>`_
nl6720's avatar
nl6720 committed
44
(respectively). Both profiles are defined by files to be placed into overlays (e.g. airootfs  the image's ``/``).
45

nl6720's avatar
nl6720 committed
46
Read `README.profile.rst <docs/README.profile.rst>`_ to learn more about how to create profiles.
47

48
49
50
51
52
53
54
55
56
57
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
nl6720's avatar
nl6720 committed
58
writeable location, as ``/usr/share/archiso`` is tracked by the package manager and only writeable by root (changes will
59
60
61
62
be lost on update).

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

63
It is advised to consult the help output of **mkarchiso**:
64

nl6720's avatar
nl6720 committed
65
.. code:: sh
66

nl6720's avatar
nl6720 committed
67
   mkarchiso -h
68
69
70
71

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

nl6720's avatar
nl6720 committed
72
.. code:: sh
73

nl6720's avatar
nl6720 committed
74
   mkarchiso -w path/to/work_dir -o path/to/out_dir path/to/profile
75
76
77
78

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

79
Clone this repository and run:
80

nl6720's avatar
nl6720 committed
81
.. code:: sh
82

nl6720's avatar
nl6720 committed
83
   ./archiso/mkarchiso -w path/to/work_dir -o path/to/out_dir path/to/profile
84
85
86
87
88

Testing
=======

The convenience script **run_archiso** is provided to boot into the medium using qemu.
89
It is advised to consult its help output:
90

nl6720's avatar
nl6720 committed
91
.. code:: sh
92

nl6720's avatar
nl6720 committed
93
   run_archiso -h
94
95
96

Run the following to boot the iso using BIOS:

nl6720's avatar
nl6720 committed
97
.. code:: sh
98

nl6720's avatar
nl6720 committed
99
   run_archiso -i path/to/an/arch.iso
100
101
102

Run the following to boot the iso using UEFI:

nl6720's avatar
nl6720 committed
103
.. code:: sh
104

nl6720's avatar
nl6720 committed
105
   run_archiso -u -i path/to/an/arch.iso
106
107
108
109

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


nl6720's avatar
nl6720 committed
110
.. code:: sh
111

nl6720's avatar
nl6720 committed
112
   ./scripts/run_archiso.sh -i path/to/an/arch.iso
113
114
115
116

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

nl6720's avatar
nl6720 committed
117
To install archiso system-wide use the included ``Makefile``:
118

nl6720's avatar
nl6720 committed
119
.. code:: sh
120

nl6720's avatar
nl6720 committed
121
   make install
122

123
124
Optionally install archiso's mkinitcpio hooks:

nl6720's avatar
nl6720 committed
125
.. code:: sh
126

nl6720's avatar
nl6720 committed
127
   make install-initcpio
128

nl6720's avatar
nl6720 committed
129
Optional features
130

nl6720's avatar
nl6720 committed
131
132
The iso image contains a GRUB environment block holding the iso name and version. This allows to
boot the iso image from GRUB with a version specific cow directory to mitigate overlay clashes.
133

nl6720's avatar
nl6720 committed
134
135
136
137
138
139
.. code:: sh
     loopback loop archlinux.iso
     load_env -f (loop)/arch/grubenv
     linux (loop)/arch/boot/x86_64/vmlinuz-linux ... \
         cow_directory=${NAME}/${VERSION} ...
     initrd (loop)/arch/boot/x86_64/initramfs-linux-lts.img
140

David Runge's avatar
David Runge committed
141
142
143
Contribute
==========

nl6720's avatar
nl6720 committed
144
Development of archiso takes place on Arch Linux' Gitlab: https://gitlab.archlinux.org/archlinux/archiso.
David Runge's avatar
David Runge committed
145
146
147
148
149
150
151
152
153

Please read our distribution-wide `Code of Conduct <https://wiki.archlinux.org/index.php/Code_of_conduct>`_ before
contributing, to understand what actions will and will not be tolerated.

Read our `contributing guide <CONTRIBUTING.rst>`_ to learn more about how to provide fixes or improvements for the code
base.

Discussion around archiso takes place on the `arch-releng mailing list
<https://lists.archlinux.org/listinfo/arch-releng>`_ and in `#archlinux-releng
154
<ircs://irc.libera.chat/archlinux-releng>`_ on `Libera Chat <https://libera.chat/>`_.
David Runge's avatar
David Runge committed
155
156
157

All past and present authors of archiso are listed in `AUTHORS <AUTHORS.rst>`_.

158
159
160
161
162
Releases
========

`Releases of archiso <https://gitlab.archlinux.org/archlinux/archiso/-/tags>`_ are created by its current maintainer
`David Runge <https://gitlab.archlinux.org/dvzrv>`_. Tags are signed using the PGP key with the ID
nl6720's avatar
nl6720 committed
163
``C7E7849466FE2358343588377258734B41C31549``.
164
165
166

To verify a tag, first import the relevant PGP key:

nl6720's avatar
nl6720 committed
167
.. code:: sh
168

nl6720's avatar
nl6720 committed
169
  gpg --auto-key-locate wkd --search-keys dvzrv@archlinux.org
170
171
172
173


Afterwards a tag can be verified from a clone of this repository:

nl6720's avatar
nl6720 committed
174
.. code:: sh
175

nl6720's avatar
nl6720 committed
176
  git verify-tag <tag>
177

178
179
180
181
License
=======

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