README.rst 4.8 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
=======
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
18
* mtools
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
* 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
36
(respectively). Both profiles are defined by files to be placed into overlays (e.g. airootfs  the image's ``/``).
37

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

40
41
42
43
44
45
46
47
48
49
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
50
writeable location, as ``/usr/share/archiso`` is tracked by the package manager and only writeable by root (changes will
51
52
53
54
be lost on update).

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

55
It is advised to consult the help output of **mkarchiso**:
56

nl6720's avatar
nl6720 committed
57
.. code:: sh
58

nl6720's avatar
nl6720 committed
59
   mkarchiso -h
60
61
62
63

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

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

nl6720's avatar
nl6720 committed
66
   mkarchiso -w path/to/work_dir -o path/to/out_dir path/to/profile
67
68
69
70

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

71
Clone this repository and run:
72

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

nl6720's avatar
nl6720 committed
75
   ./archiso/mkarchiso -w path/to/work_dir -o path/to/out_dir path/to/profile
76
77
78
79
80

Testing
=======

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

nl6720's avatar
nl6720 committed
83
.. code:: sh
84

nl6720's avatar
nl6720 committed
85
   run_archiso -h
86
87
88

Run the following to boot the iso using BIOS:

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

nl6720's avatar
nl6720 committed
91
   run_archiso -i path/to/an/arch.iso
92
93
94

Run the following to boot the iso using UEFI:

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

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

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


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

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

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

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

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

nl6720's avatar
nl6720 committed
113
   make install
114

115
116
Optionally install archiso's mkinitcpio hooks:

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

nl6720's avatar
nl6720 committed
119
   make install-initcpio
120

nl6720's avatar
nl6720 committed
121
Optional features
122

nl6720's avatar
nl6720 committed
123
124
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.
125

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

David Runge's avatar
David Runge committed
133
134
135
Contribute
==========

nl6720's avatar
nl6720 committed
136
Development of archiso takes place on Arch Linux' Gitlab: https://gitlab.archlinux.org/archlinux/archiso.
David Runge's avatar
David Runge committed
137
138
139
140
141
142
143
144
145
146
147
148
149

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>`_.

150
151
152
153
154
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
155
``C7E7849466FE2358343588377258734B41C31549``.
156
157
158

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

nl6720's avatar
nl6720 committed
159
.. code:: sh
160

nl6720's avatar
nl6720 committed
161
  gpg --auto-key-locate wkd --search-keys dvzrv@archlinux.org
162
163
164
165


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

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

nl6720's avatar
nl6720 committed
168
  git verify-tag <tag>
169

170
171
172
173
License
=======

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