diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/README.altbootmethods | 6 | ||||
| -rw-r--r-- | docs/README.bootparams | 46 | ||||
| -rw-r--r-- | docs/README.build | 58 | ||||
| -rw-r--r-- | docs/README.transfer | 6 |
4 files changed, 36 insertions, 80 deletions
diff --git a/docs/README.altbootmethods b/docs/README.altbootmethods index d9acc89..e246540 100644 --- a/docs/README.altbootmethods +++ b/docs/README.altbootmethods @@ -81,7 +81,7 @@ Note: All NIC firmwares should support this. --enable-tftp \ --tftp-root=/run/parabolaiso/bootmnt \ --dhcp-range=192.168.0.2,192.168.0.254,86400 \ - --dhcp-boot=/parabola/boot/syslinux/gpxelinux.0 \ + --dhcp-boot=/parabola/boot/syslinux/lpxelinux.0 \ --dhcp-option-force=209,boot/syslinux/parabolaiso.cfg \ --dhcp-option-force=210,/parabola/ @@ -92,7 +92,7 @@ Note: Not all NIC firmware supports HTTP and DNS (if domain name is used). # dnsmasq --port=0 \ --dhcp-range=192.168.0.2,192.168.0.254,86400 \ - --dhcp-boot=http://192.168.0.7/parabola/boot/syslinux/gpxelinux.0 \ + --dhcp-boot=http://192.168.0.7/parabola/boot/syslinux/lpxelinux.0 \ --dhcp-option-force=209,boot/syslinux/parabolaiso.cfg \ --dhcp-option-force=210,http://192.168.0.7/parabola/ @@ -109,7 +109,7 @@ methods can be used to serve the rest of live-medium. * NFS # echo "/run/parabolaiso/bootmnt 192.168.0.*(ro,no_subtree_check,no_root_squash)" >> /etc/exports -# systemctl start rpc-mountd.service +# systemctl start nfs-server.service * NBD diff --git a/docs/README.bootparams b/docs/README.bootparams index 7139976..b9eadb4 100644 --- a/docs/README.bootparams +++ b/docs/README.bootparams @@ -23,8 +23,6 @@ INDEX Default: "/dev/disk/by-label/${parabolaisolabel}" * parabolaisobasedir= Set the base directory where all files reside. Default: "parabola" -* aitab= Set the path for "aitab" file. - Default: ${parabolaisobasedir}/aitab * copytoram= If set to "y" or just "copytoram" without arguments, all SquashFS are copied to "RAM". Default: (unset) @@ -32,47 +30,47 @@ INDEX performs a self-test of all files inside ${install_dir}, and continue booting if ok. Default: (unset) -* cow_label= Set the filesystem label where COW (dm-snapshot) - files must be stored. +* cow_label= Set the filesystem label where COW file (for dm-snapshot) + or upperdir/workdir files (for overlayfs) must be stored. Default: (unset) -* cow_device= Set the device node where COW (dm-snapshot) files - must be stored. +* cow_device= Like cow_label= but using device node. Default: (unset) or "/dev/disk/by-label/${cow_label}" +* cow_flags= Set extra mount options, e.g. for btrfs subvolumes. + Default: defaults * cow_directory= Set a directory inside ${cow_device}. Default: "/persistent_${parabolaisolabel}/${arch}" -* cow_persistent= Set if snapshots are persistent "P" or non-persistent "N". +* cow_persistent= Set if snapshot is persistent "P" or non-persistent "N". + Only used for dm-snapshot mode, ignored for overlayfs. Default: "N" (if no ${cow_device} is used) otherwise "P". -* cowspace_size= Set the size of tmpfs /cowspace. This space is used for - Copy-On-Write files of dm-snapshot. - Size is in bytes (suffix with "k", "m" and "g") or - in percentage of available RAM. - Default: "75%" -* cowfile_size= Set the size for all files to be used as COW (dm-snapshot), - in percentage of the ro-device.fs file. This is mostly useful - when cow_device= is used and filesystem does not support - sparse files (ie VFAT). - Default: "100%" +* cow_spacesize= Set the size for COW space (tmpfs). Valid for both + dm-snapshot and overlayfs mode. + The argument is an integer and optional unit. + Units are M,G (powers of 1024). + Default: "256M" +* cow_chunksize= Set chunksize used for dm-snapshot. This is number + of 512 byte blocks to write at once. + Default: "8" * copytoram_size= Set the size of tmpfs. This space is used for - copy of all SquashFS images used, if copytoram=y. + airootfs.sfs image if copytoram=y. Size is in bytes (suffix with "k", "m" and "g") or in percentage of available RAM. Default: "75%" -* dm_snap_prefix= Set a prefix for device-mapper snapshot node names. +* dm_snap_prefix= Set a prefix for dm-snapshot node names. + Only used for dm-snapshot mode, ignored for overlayfs. Default: "parabola" * arch= Force an architecture type (i686 | x86_64). Do not set it for normal operations. - Useful for running a 64 bit kernel / 32 bit userspace. Default: (architecture of running kernel) ** hooks/parabolaiso_pxe_common * ip= This parameter is setup automatically by PXELINUX - when option "IPAPPEND" is set to 1 or 2 in config. + when option "SYSAPPEND" is set to 1 or 2 in config. ip=<client-ip>:<boot-server-ip>:<gw-ip>:<netmask> Default: (set via PXE server) * BOOTIF= This parameter is setup automatically by PXELINUX - when option "IPAPPEND" is set to 2 or 3 in config. + when option "SYSAPPEND" is set to 2 or 3 in config. BOOTIF=<hardware-address-of-boot-interface> Default: (set via PXELINUX) * copy_resolvconf= Copy /etc/resolv.conf from initramfs to live-enviroment. @@ -125,6 +123,8 @@ INDEX Default: (unset) * img_dev= Device where parabolaiso-image.iso reside. Default: (unset) or "/dev/disk/by-label/${img_label}" +* img_flags= Set extra mount options, e.g. for btrfs subvolumes. + Default: defaults * img_loop= Full path where parabolaiso-image.iso is located on ${img_dev} Default: (unset) @@ -136,6 +136,6 @@ INDEX * mirror= Takes a mirror URL and creates a new mirrorlist. When setting mirror=auto, the mirror is taken from - archiso_http_srv= in order to keep using the mirror + parabolaiso_http_srv= in order to keep using the mirror selected in the netboot menu. Default: (unset) diff --git a/docs/README.build b/docs/README.build index f2fb594..a85dbde 100644 --- a/docs/README.build +++ b/docs/README.build @@ -2,9 +2,6 @@ INDEX ----- * Build requirements -* Image types generated by mkparabolaiso. -* File format for aitab. -* Why the /isolinux and /parabola/boot/syslinux directories? * Building the most basic Parabola GNU/Linux-libre live media. (configs/baseline) * Building official Parabola GNU/Linux-libre live media. (configs/releng) @@ -13,15 +10,16 @@ INDEX *** Build requirements ** For mkparabolaiso script needs these packages (build host): + + arch-install-scripts for pacstrap/arch-chroot + squashfs-tools for mksquashfs + libisoburn for xorriso + btrfs-progs for mkfs.btrfs (optional) ** For configs/releng build.sh needs theses packages (build host): - + dosfstools for mkfs.vfat + + dosfstools for mkfs.fat + lynx for fetching the latest installation guide -** For these hooks needs these packages (on target root-image) +** For these hooks needs these packages (on target airootfs) * parabolaiso + (none) * parabolaiso_loop_mnt @@ -38,55 +36,13 @@ INDEX + (none) -*** Image types generated by mkparabolaiso. - -* image-name.sfs SquashFS image with all files directly on it. - [read-only, no dm-snapshot is used] -* image-name.fs.sfs SquashFS with only one file inside (image-name.fs), - which is an image of some type of filesystem - (ext4, ext3, ext2, xfs, btrfs), all files reside on it. - [read-write, via COW image with dm-snapshot] - - -*** File format for aitab. - -The aitab file holds information about the filesystems images that must be -created by mkparabolaiso and mounted at initramfs stage from the parabolaiso hook. -It consists of some fields which define the behaviour of images. - -# <img> <mnt> <arch> <sfs_comp> <fs_type> <fs_size> - -<img> Image name without extension (.fs .fs.sfs .sfs). -<mnt> Mount point. -<arch> Architecture { i686 | x86_64 | any }. -<sfs_comp> SquashFS compression type { gzip | lzo | xz }. -<fs_type> Set the filesystem type of the image - { ext4 | ext3 | ext2 | xfs | btrfs }. - A special value of "none" denotes no usage of a filesystem. - In that case all files are pushed directly to SquashFS filesystem. -<fs_size> An absolute value of file system image size in MiB. - (example: 100, 1000, 4096, etc) - A relative value of file system free space [in percent]. - {1%..99%} (example 50%, 10%, 7%). - This is an estimation, and calculated in a simple way. - Space used + 10% (estimated for metadata overhead) + desired % - - -*** Why the /isolinux and /parabola/boot/syslinux directories? - -The /isolinux directory holds files needed for the ISOLINUX boot loader -module of SYSLINUX. ISOLINUX can not find config files on -/parabola/boot/syslinux, like other boot loaders modules (SYSLINUX, PXELINUX). - - - *** Building the most basic Parabola GNU/Linux-libre live media. (configs/baseline) * Install needed packages. - # pacman -S git make squashfs-tools libisoburn rsync --needed + # pacman -S git make arch-install-scripts squashfs-tools libisoburn --needed * Install parabolaiso. - # git clone git://projects.parabolagnulinux.org/parabolaiso.git + # git clone git://git.parabola.nu/packages/parabolaiso.git # make -C parabolaiso install * Build a basic iso. @@ -99,10 +55,10 @@ used to build official images with much more things. *** Building official Parabola GNU/Linux-libre live media. (configs/releng) * Install needed packages. - # pacman -S git make squashfs-tools libisoburn dosfstools lynx --needed + # pacman -S git make arch-install-scripts squashfs-tools libisoburn dosfstools lynx --needed * Install parabolaiso. - # git clone git://projects.parabolagnulinux.org/parabolaiso.git + # git clone git://git.parabola.nu/packages/parabolaiso.git # make -C parabolaiso install * Build them! diff --git a/docs/README.transfer b/docs/README.transfer index f6879e0..2cf28e3 100644 --- a/docs/README.transfer +++ b/docs/README.transfer @@ -72,7 +72,7 @@ Note: Type "b" for FAT32, "83" for EXTFS or "7" for NTFS. 2) Create a FAT32, EXTFS or NTFS filesystem on such partition and setup a label. Note: COW is not supported on NTFS. -# mkfs.vfat -F 32 -n <FS-LABEL> <DEV-TARGET-N> +# mkfs.fat -F 32 -n <FS-LABEL> <DEV-TARGET-N> # mkfs.ext4 -L <FS-LABEL> <DEV-TARGET-N> # mkfs.ntfs -L <FS-LABEL> <DEV-TARGET-N> @@ -89,7 +89,7 @@ Note: COW is not supported on NTFS. # umount <MNT-TARGET-N> 7) Install syslinux MBR boot code on target drive. -# dd bs=440 count=1 conv=notrunc if=/usr/lib/syslinux/mbr.bin of=<DEV-TARGET> +# dd bs=440 count=1 conv=notrunc if=/usr/lib/syslinux/bios/mbr.bin of=<DEV-TARGET> * PC-BIOS (ISOHYBRID-MBR): @@ -111,7 +111,7 @@ Note: Using here a GPT partition mode as example, but MBR should also works # gdisk <DEV-TARGET> 2) Create a FAT32 filesystem on such partition and setup a label. -# mkfs.vfat -F 32 -n <FS-LABEL> <DEV-TARGET-N> +# mkfs.fat -F 32 -n <FS-LABEL> <DEV-TARGET-N> 3) Mount target filesystem. # mount <DEV-TARGET-N> <MNT-TARGET-N> |