Skip to content

Commit fdbccc2

Browse files
committed
Document mirrors more clearly
1 parent f21d2d7 commit fdbccc2

File tree

1 file changed

+31
-0
lines changed

1 file changed

+31
-0
lines changed

README.rst

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,10 @@ How do I use this?
1717

1818
Quick start:
1919

20+
Choose a mirror from https://github.com/fosslinux/live-bootstrap/wiki/Mirrors,
21+
or create a private/public mirror yourself (see further below). You should
22+
provide the mirror as ``--mirror`` to ``rootfs.py``.
23+
2024
See ``./rootfs.py --help`` and follow the instructions given there.
2125
This uses a variety of userland tools to prepare the bootstrap.
2226

@@ -25,6 +29,8 @@ preparations! This is a currently unsolved problem.*)
2529

2630
Without using Python:
2731

32+
0. Choose a mirror as detailed above. (You will input this later, instead of
33+
passing it to ``rootfs.py```).
2834
1. ``git clone https://github.com/fosslinux/live-bootstrap``
2935
2. ``git submodule update --init --recursive``
3036
3. Consider whether you are going to run this in a chroot, in QEMU, or on bare
@@ -68,6 +74,31 @@ Without using Python:
6874
c. **Bare metal:** Follow the same steps as QEMU, but the disks need to be
6975
two different *physical* disks, and boot from the first disk.
7076

77+
Mirrors
78+
-------
79+
80+
It has been decided that repackaging distfiles for live-bootstrap is generally
81+
permissible, particularly from git repositories. We do this primarily because
82+
83+
a. currently live-bootstrap only supports tarballs/raw files as input, not git
84+
repositories
85+
b. to reduce load on servers
86+
87+
You may choose to use an existing mirror from
88+
https://github.com/fosslinux/live-bootstrap/wiki/Mirrors, however you may be
89+
(to some varied extent) trusting the operator of the mirror.
90+
91+
Alternatively, you can create your own local mirror - one such implementation
92+
is in ``./mirror.sh``. You can invoke it with
93+
``./mirror.sh path/to/mirror/dir path/to/mirror/state``.
94+
You would then pass ``--mirror path/to/mirror/dir`` to rootfs.py.
95+
(If not using rootfs.py, you need to copy files around manually into distfiles.)
96+
97+
Most helpfully to the project, you could create your own public mirror, by
98+
running ``./mirror.sh`` or writing your own script that does something similar
99+
on a timer (systemd timer or cron job, for example), where the mirror directory
100+
is publicly accessible on the Internet (ideally, via HTTP and HTTPS).
101+
71102
Background
72103
----------
73104

0 commit comments

Comments
 (0)