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

5
6
The archiso project features scripts and configuration templates to build installation media (*.iso* images and
*.tar.gz* bootstrap images) for BIOS and UEFI based systems on the x86_64 architecture.
7
8
9
10
11
12
13
14
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
15
* awk
16
17
* dosfstools
* e2fsprogs
18
19
20
21
* erofs-utils (optional)
* findutils
* gzip
* libarchive
22
* libisoburn
23
* mtools
24
25
* pacman
* sed
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
* 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
43
(respectively). Both profiles are defined by files to be placed into overlays (e.g. airootfs  the image's ``/``).
44

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

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

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

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

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

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

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

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

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

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

78
Clone this repository and run:
79

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

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

Testing
=======

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

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

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

Run the following to boot the iso using BIOS:

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

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

Run the following to boot the iso using UEFI:

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

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

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


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

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

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

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

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

nl6720's avatar
nl6720 committed
120
   make install
121

122
123
Optionally install archiso's mkinitcpio hooks:

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

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

nl6720's avatar
nl6720 committed
128
Optional features
129

nl6720's avatar
nl6720 committed
130
131
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.
132

nl6720's avatar
nl6720 committed
133
134
135
136
137
138
.. 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
139

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

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

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
<ircs://chat.freenode.net/archlinux-releng>`_ on `freenode.net <https://freenode.net/>`_.

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

157
158
159
160
161
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
162
``C7E7849466FE2358343588377258734B41C31549``.
163
164
165

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

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

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


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

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

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

177
178
179
180
License
=======

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