This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision Next revision Both sides next revision | ||
doc:howto:tce [2021/01/25 00:19] stefanbaur [Starting the Build] This is part two of the patch to create Images for the Raspberry Pi |
doc:howto:tce [2024/01/26 18:38] stefanbaur [Client Branding/Theming using SVGs] |
||
---|---|---|---|
Line 45: | Line 45: | ||
# it's apt-cacher-ng and use it | # it's apt-cacher-ng and use it | ||
# | # | ||
- | if nc -z 127.0.0.1 3142 ; then | + | if nc -z 127.0.0.1 3142 ; then |
# bad idea with apt-cacher-ng, | # bad idea with apt-cacher-ng, | ||
- | # export https_proxy=http:// | + | # export https_proxy=http:// |
# export http_proxy=http:// | # export http_proxy=http:// | ||
# export ftp_proxy=http:// | # export ftp_proxy=http:// | ||
Line 61: | Line 61: | ||
# Select ONE of the following git reposities | # Select ONE of the following git reposities | ||
# this one loosely corresponds to " | # this one loosely corresponds to " | ||
- | # export LBX2GO_CONFIG=' | + | #export LBX2GO_CONFIG=' |
- | # this one loosely corresponds to " | + | #export LBX2GO_CONFIG=' |
- | export LBX2GO_CONFIG=' | + | export LBX2GO_CONFIG=' |
- | # NOTE: Add " | + | #export LBX2GO_CONFIG=' |
- | # NOTE: As of 2019-08-27, buster builds are only available via the github repo and for the feature/ | + | #export LBX2GO_CONFIG=' |
+ | #export LBX2GO_CONFIG=' | ||
+ | # NOTES: 1) https:// | ||
+ | # 2) Minidesktop builds are work in progress and not production-ready. Cont(r)act us if you need them; feel free to submit patches. | ||
+ | # 3) Add " | ||
+ | # | ||
+ | # add " | ||
+ | # add "-bookworm" | ||
# Select ONE of the following LBX2GO_ARCH lines and comment out the others | # Select ONE of the following LBX2GO_ARCH lines and comment out the others | ||
Line 72: | Line 79: | ||
export LBX2GO_ARCH=' | export LBX2GO_ARCH=' | ||
# 32-Bit, larger memory footprint, but faster performance on i686 and newer | # 32-Bit, larger memory footprint, but faster performance on i686 and newer | ||
- | # export LBX2GO_ARCH=' | + | #export LBX2GO_ARCH=' |
# 32-Bit, smallest memory footprint - not available on buster | # 32-Bit, smallest memory footprint - not available on buster | ||
# export LBX2GO_ARCH=' | # export LBX2GO_ARCH=' | ||
Line 81: | Line 88: | ||
# If you want to use the stock ISO image as created by this script, add your boot parameters here | # If you want to use the stock ISO image as created by this script, add your boot parameters here | ||
# export LBX2GO_BOOTAPPEND_LIVE=" | # export LBX2GO_BOOTAPPEND_LIVE=" | ||
+ | export LBX2GO_BOOTAPPEND_LIVE=" | ||
if echo -e " | if echo -e " | ||
- | | + | LBX2GO_BOOTAPPEND_LIVE+=" |
- | export LBX2GO_BOOTAPPEND_LIVE | + | export LBX2GO_BOOTAPPEND_LIVE |
elif echo -e " | elif echo -e " | ||
- | | + | LBX2GO_BOOTAPPEND_LIVE+=' |
- | export LBX2GO_BOOTAPPEND_LIVE | + | export LBX2GO_BOOTAPPEND_LIVE |
fi | fi | ||
Line 103: | Line 111: | ||
export LBX2GO_DEBVERSION=" | export LBX2GO_DEBVERSION=" | ||
export LBX2GO_BOOTAPPEND_LIVE+=" | export LBX2GO_BOOTAPPEND_LIVE+=" | ||
+ | elif [ -z " | ||
+ | export LBX2GO_DEBVERSION=" | ||
+ | export LBX2GO_BOOTAPPEND_LIVE+=" | ||
+ | elif [ -z " | ||
+ | export LBX2GO_DEBVERSION=" | ||
+ | export LBX2GO_BOOTAPPEND_LIVE+=" | ||
+ | export LBX2GO_ARCHIVE_AREAS=" | ||
else | else | ||
export LBX2GO_DEBVERSION=" | export LBX2GO_DEBVERSION=" | ||
Line 125: | Line 140: | ||
# These options are meant to reduce the image size. | # These options are meant to reduce the image size. | ||
# Feel free to adapt them after consulting "man lb_config" | # Feel free to adapt them after consulting "man lb_config" | ||
- | export LBX2GO_SPACE=' | + | # FIXME export LBX2GO_SPACE=' |
+ | export LBX2GO_SPACE=' | ||
| | ||
| | ||
Line 171: | Line 187: | ||
fi | fi | ||
- | export LBX2GO_ARCHIVE_AREAS=" | + | export LBX2GO_ARCHIVE_AREAS=" |
# This is for minidesktop builds and currently only adds firefox-esr language packs | # This is for minidesktop builds and currently only adds firefox-esr language packs | ||
Line 178: | Line 194: | ||
# This is to optimize squashfs size, based on a suggestion by intrigeri from the TAILS team | # This is to optimize squashfs size, based on a suggestion by intrigeri from the TAILS team | ||
# note that this will permanently change / | # note that this will permanently change / | ||
+ | # | ||
+ | # | ||
if dpkg --print-architecture | grep -q ' | if dpkg --print-architecture | grep -q ' | ||
- | | + | # on arm, these parameters must not be used; if they' |
- | if grep -q -- '-Xbcj x86 -b 1024K -Xdict-size 1024K' / | + | if grep -q -- '-Xbcj x86 -b 1024K -Xdict-size 1024K' / |
- | apt install --reinstall live-build | + | apt install --reinstall live-build |
- | fi | + | fi |
+ | # feel free to experiment with these options, but be prepared for subtle breakage | ||
+ | #export MKSQUASHFS_OPTIONS=' | ||
+ | #export MKSQUASHFS_OPTIONS=' | ||
+ | #export MKSQUASHFS_OPTIONS=' | ||
+ | export MKSQUASHFS_OPTIONS='' | ||
else | else | ||
- | sed -i -e 's#MKSQUASHFS_OPTIONS=" | + | export |
fi | fi | ||
Line 194: | Line 217: | ||
# This patches the squashfs file into the initrd. Only parsed when image type " | # This patches the squashfs file into the initrd. Only parsed when image type " | ||
# Will require boot parameter live-media=/ | # Will require boot parameter live-media=/ | ||
- | # Both TFTP client and TFTP server must support file transfers >32MB for this to work, if you want to deploy this initrd via TFTP, | + | # Both TFTP client and TFTP server must support file transfers >32MB for this to work, if you want to deploy this initrd via TFTP, |
# so e.g. atftpd will not work - tftpd-hpa, however, seems to have no problem with larger files. | # so e.g. atftpd will not work - tftpd-hpa, however, seems to have no problem with larger files. | ||
# When using iPXE, you can use http instead of TFTP. | # When using iPXE, you can use http instead of TFTP. | ||
# This is especially helpful if you want to netboot via http and cannot use the server' | # This is especially helpful if you want to netboot via http and cannot use the server' | ||
- | export LBX2GO_NOSQUASHFS=" | + | #export LBX2GO_NOSQUASHFS=" |
# Select ONE of the following LBX2GO_IMAGETYPE lines and comment out the others | # Select ONE of the following LBX2GO_IMAGETYPE lines and comment out the others | ||
# to create an iso image: | # to create an iso image: | ||
- | # export LBX2GO_IMAGETYPE=' | + | #export LBX2GO_IMAGETYPE=' |
# to create an iso image that can also be dd'ed to USB media: | # to create an iso image that can also be dd'ed to USB media: | ||
- | # export LBX2GO_IMAGETYPE=' | + | export LBX2GO_IMAGETYPE=' |
# to create a netboot-image: | # to create a netboot-image: | ||
- | export LBX2GO_IMAGETYPE=' | + | #export LBX2GO_IMAGETYPE=' |
# /!\ the options below are NOT RECOMMENDED unless you use live-build from Debian Buster /!\ | # /!\ the options below are NOT RECOMMENDED unless you use live-build from Debian Buster /!\ | ||
- | # to create an image that can be written to a hard disk (for older live-build versions, this | + | # (Debian 10) or newer to create an image that can be written to a hard disk (for older |
- | # always results in a "build failed" | + | # live-build versions, this always results in a "build failed" |
- | # live-build from Buster and things will work): | + | # might have worked - use live-build from Buster |
- | # export LBX2GO_IMAGETYPE=' | + | #export LBX2GO_IMAGETYPE=' |
+ | ## This might be required for hdd builds, especially for (u)efi | ||
+ | #export LBX2GO_BOOTLOADER=" | ||
# to create a tar file only (seems to be broken in older live-build versions - Buster works): | # to create a tar file only (seems to be broken in older live-build versions - Buster works): | ||
- | # export LBX2GO_IMAGETYPE=' | + | #export LBX2GO_IMAGETYPE=' |
# This is part of our experimental ARM support | # This is part of our experimental ARM support | ||
if echo " | if echo " | ||
- | | + | # enforce hdd image for arm at the moment (might need to support netboot later on too) |
- | if ! [ " | + | if ! [ " |
- | echo " | + | |
- | LBX2GO_IMAGETYPE=" | + | export |
- | fi | + | fi |
fi | fi | ||
if [ " | if [ " | ||
- | LBX2GO_DEFAULTS+=" | + | |
fi | fi | ||
</ | </ | ||
==== Live-Patching the Build ==== | ==== Live-Patching the Build ==== | ||
- | This patch is required if you need USB mount capability on the ThinClient while [[http://bugs.x2go.org/cgi-bin/bugreport.cgi? | + | To add patches that aren't part of any package yet, you can use the directory ./patch/ for patches that should be added to all versions, and ./patch-minidesktop/ for patches that should only be added to the MATE-MiniDesktop Edition. |
- | Save this script in the directory where you want to save your builds and run it before calling | + | |
+ | You will need to create a directory structure like < | ||
+ | |||
+ | e.g. to override < | ||
< | < | ||
#!/bin/bash | #!/bin/bash | ||
- | mkdir -p ./ | ||
- | wget -O ./ | ||
- | chmod 755 ./ | ||
- | </ | ||
+ | # Copyright (C) 2010-2024 by X2Go project, https:// | ||
+ | # | ||
+ | # | ||
+ | # Mike Gabriel < | ||
+ | # | ||
+ | # | ||
+ | # X2Go is free software; you can redistribute it and/or modify | ||
+ | # it under the terms of the GNU General Public License as published by | ||
+ | # the Free Software Foundation; either version 2 of the License, or | ||
+ | # (at your option) any later version. | ||
+ | # | ||
+ | # X2Go is distributed in the hope that it will be useful, | ||
+ | # but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
+ | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. | ||
+ | # GNU General Public License for more details. | ||
+ | # | ||
+ | # You should have received a copy of the GNU General Public License | ||
+ | # along with this program; if not, write to the | ||
+ | # Free Software Foundation, Inc., | ||
+ | # 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA. | ||
+ | |||
+ | # make sure pulseaudio can be reached via TCP from the X2Go Server side... | ||
+ | if ! / | ||
+ | / | ||
+ | fi | ||
+ | |||
+ | # make sure we don't start before sessions and settings files exist - avoids race conditions | ||
+ | while ! [ -e ~x2gothinclient/ | ||
+ | sleep 1; | ||
+ | done | ||
+ | |||
+ | while ! [ -e ~x2gothinclient/ | ||
+ | sleep 1 | ||
+ | done | ||
+ | |||
+ | [ -s / | ||
+ | [ -s / | ||
+ | |||
+ | |||
+ | / | ||
+ | | ||
+ | | ||
+ | | ||
+ | | ||
+ | | ||
+ | | ||
+ | | ||
+ | | ||
+ | & | ||
+ | |||
+ | </ | ||
==== Starting the Build ==== | ==== Starting the Build ==== | ||
In the directory where you want to save your builds, save the following file as x2go-tce-build, | In the directory where you want to save your builds, save the following file as x2go-tce-build, | ||
Line 251: | Line 325: | ||
LBX2GO_TIMESTAMP=$(date +" | LBX2GO_TIMESTAMP=$(date +" | ||
+ | # Log all output to a logfile in /tmp | ||
exec > >(tee "/ | exec > >(tee "/ | ||
Line 257: | Line 332: | ||
if [ -z " | if [ -z " | ||
- | | + | ( echo " |
[ -z " | [ -z " | ||
[ -z " | [ -z " | ||
Line 327: | Line 402: | ||
if echo $LBX2GO_ARCH | grep -q " | if echo $LBX2GO_ARCH | grep -q " | ||
- | | + | # bullseye and newer do not need this |
- | echo " | + | if [ " |
+ | # firmware for wifi | ||
+ | echo " | ||
+ | fi | ||
- | | + | if [ " |
- | # modules required for Raspberry Pi 3 LAN | + | # modules required for Raspberry Pi 3 LAN |
- | echo " | + | echo " |
- | echo " | + | echo " |
- | echo " | + | echo " |
- | echo " | + | echo " |
- | echo " | + | echo " |
- | echo " | + | echo " |
- | echo " | + | echo " |
- | | + | # firmware for basic raspi functions - required for boot on Pi3 |
- | echo " | + | echo " |
- | # standard linux kernel - for Pi3 | + | # standard linux kernel - for Pi3 |
- | echo " | + | echo " |
- | | + | elif [ " |
- | # firmware for basic raspi functions - required for boot on Pi4 | + | # bullseye and newer do not need this |
- | echo " | + | if [ " |
- | echo " | + | # firmware for basic raspi functions - required for boot on Pi4 |
- | + | echo " | |
- | # newer linux kernel - required for pi4/pi400 | + | echo " |
- | echo " | + | |
- | + | ||
- | else | + | |
- | echo " | + | |
- | fi | + | |
+ | # newer linux kernel - required for pi4/pi400 | ||
+ | echo " | ||
+ | fi | ||
+ | else | ||
+ | echo " | ||
+ | fi | ||
fi | fi | ||
+ | |||
# This is for minidesktop builds only | # This is for minidesktop builds only | ||
Line 390: | Line 469: | ||
# at files not being downloaded, disable these three entries. | # at files not being downloaded, disable these three entries. | ||
export https_proxy=$LB_APT_HTTP_PROXY | export https_proxy=$LB_APT_HTTP_PROXY | ||
- | | + | export http_proxy=$LB_APT_HTTP_PROXY |
export ftp_proxy=$LB_APT_FTP_PROXY | export ftp_proxy=$LB_APT_FTP_PROXY | ||
fi | fi | ||
Line 396: | Line 475: | ||
# This is part of our experimental ARM support | # This is part of our experimental ARM support | ||
# It is used when building for the ARM architecture (on Intel/AMD hardware and on ARM). | # It is used when building for the ARM architecture (on Intel/AMD hardware and on ARM). | ||
- | # It makes some necessary changes, and also tries to speed up squashfs creation when it | + | # It makes some necessary changes, and also tries to speed up squashfs creation when it |
# detects a crossbuild environment. | # detects a crossbuild environment. | ||
if echo $LBX2GO_ARCH | grep -q ' | if echo $LBX2GO_ARCH | grep -q ' | ||
Line 405: | Line 484: | ||
sed -e ' | sed -e ' | ||
- | | + | # This command removes the X2Go repository from the directory where additional |
- | # archives are stored. | + | # archives are stored. |
# packages, but Debian Buster does - so that's what we're falling back to. | # packages, but Debian Buster does - so that's what we're falling back to. | ||
echo " | echo " | ||
rm ./ | rm ./ | ||
- | | + | # The following is a hack to reduce squashfs creation time in a crossbuild environment. |
- | # We're replacing mksquashfs in the changeroot with a wrapper script that drops the | + | # We're replacing mksquashfs in the changeroot with a wrapper script that drops the |
- | # original mksquashfs call into a file. | + | # original mksquashfs call into a file. |
- | | + | if (uname -r | grep -q ' |
- | # We need to do this as a background task, waiting for the mksquashfs executable to | + | # We need to do this as a background task, waiting for the mksquashfs executable to |
- | # appear in the changeroot; as the changeroot will only be created later on, once | + | # appear in the changeroot; as the changeroot will only be created later on, once |
- | # lb build is called. | + | # lb build is called. |
+ | |||
+ | # The other background task waits until the command file has been created, then | ||
+ | # it applies some necessary patches to it, and starts the mksquashfs command natively | ||
+ | # on the build host, rather than in the changeroot environment. | ||
+ | # This is because in the changeroot, we'd be running the ARM mksquashfs in a qemu | ||
+ | # software emulation of the ARM architecture, | ||
+ | # native, raw CPU power and cores available to us. | ||
- | | + | # To make sure we don't have any lingering processes in the background, we're passing |
- | # it applies some necessary patches | + | # our own PID along to the background tasks, and tell them to terminate if our PID |
- | # on the build host, rather than in the changeroot environment. | + | # disappears while they're still in their waiting/ |
- | # This is because in the changeroot, we'd be running the ARM mksquashfs | + | |
- | # software emulation of the ARM architecture, | + | |
- | # native, raw CPU power and cores available to us. | + | |
- | # To make sure we don't have any lingering processes in the background, we're passing | + | MASTERPID=$$ |
- | # our own PID along to the background tasks, and tell them to terminate if our PID | + | |
- | # disappears while they' | + | |
- | | + | # Replace mksquashfs in chroot with script |
+ | # (script will undo this upon completion) | ||
+ | ( | ||
+ | # wait until the chroot has been populated or until our parent process dies | ||
+ | while ! [ -x ./ | ||
+ | ps $MASTERPID | ||
+ | sleep 1 | ||
+ | done | ||
+ | # make sure we don't overwrite the real executable if it has already been | ||
+ | # moved out of the way | ||
+ | if ! [ -x ./ | ||
+ | cp ./ | ||
+ | fi | ||
+ | echo '# | ||
+ | # log the name we've been called with and all parameters into this file | ||
+ | echo 'echo "$0 $@" >/ | ||
+ | # once the native mksquashfs is complete, we will remove this file | ||
+ | echo 'while [ -f / | ||
+ | echo ' | ||
+ | echo ' | ||
+ | # so let's wait until it has been removed before deleting ourselves ... | ||
+ | echo 'rm / | ||
+ | # ... and moving the real executable back into its place | ||
+ | echo 'mv / | ||
+ | chmod 755 ./ | ||
+ | ) & | ||
- | | + | # start the native |
- | # (script will undo this upon completion) | + | ( |
- | | + | |
- | # wait until the chroot | + | |
- | while ! [ -x ./chroot/usr/bin/ | + | ps $MASTERPID >/ |
- | ps $MASTERPID >/ | + | sleep 1 |
- | sleep 1 | + | |
- | done | + | |
- | # make sure we don't overwrite | + | |
- | # moved out of the way | + | # parameter completely |
- | if ! [ -x ./chroot/ | + | # also, all absolute paths (detected by beginning with " |
- | | + | # prefixed with "./chroot" so the mksquashfs |
- | fi | + | # to look for the corresponding paths/files. |
- | | + | sed -e 's/ -Xbcj x86/ /g' |
- | # log the name we've been called with and all parameters into this file | + | ./chroot/ |
- | echo 'echo "$0 $@" >/ | + | #needs switch from e.g. / |
- | | + | sed -e "s#^.*mksquashfs#$(which mksquashfs)# |
- | echo 'while [ -f / | + | ./chroot/ |
- | echo ' | + | |
- | echo ' | + | |
- | # so let' | + | |
- | echo 'rm / | + | |
- | # ... and moving the real executable | + | |
- | echo 'mv / | + | |
- | chmod 755 ./chroot/usr/bin/ | + | |
- | ) & | + | |
- | # start the native mksquashfs after patching the parameters | + | |
- | ( | + | |
- | # wait until the trigger file has been created or until our parent process dies | + | |
- | while ! [ -f ./ | + | |
- | ps $MASTERPID >/ | + | |
- | sleep 1 | + | |
- | done | + | |
- | # using any of the available filters (x86, arm, armthumb) for the | + | |
- | # -Xbcj command results in an unusable squashfs on arm, so we drop the | + | |
- | # parameter completely if it's there. | + | |
- | # also, all absolute paths (detected by beginning with " /") need to be | + | |
- | # prefixed with " | + | |
- | # to look for the corresponding paths/ | + | |
- | sed -e 's/ -Xbcj x86/ /g' -e 's# /# ./ | + | ) & |
- | ./ | + | fi |
- | #needs switch from e.g. / | + | |
- | sed -e " | + | |
- | ./ | + | |
- | # now let's make this executable | + | |
- | chmod 755 ./ | + | |
- | + | ||
- | | + | |
- | # in the squashfs - no idea why we don't need them while inside the chroot ... | + | |
- | echo ' | + | |
- | echo ' | + | |
- | echo ' | + | |
- | # now let's execute the script and, if it terminates without an error, | + | |
- | # we'll move the newly created squashfs into the chroot where the chrooted | + | |
- | # mksquashfs command would have created it; if that worked as well, we' | + | |
- | # remove the script file so our dummy mksquashfs inside the chroot knows | + | |
- | # it's time to terminate itself. | + | |
- | ./ | + | |
- | mv ./ | + | |
- | rm ./ | + | |
- | ) & | + | |
- | fi | + | |
fi | fi | ||
Line 511: | Line 590: | ||
# This is part of our experimental ARM support | # This is part of our experimental ARM support | ||
if [ " | if [ " | ||
- | | + | # after the build, let's determine the name of our image file ... |
- | IMAGEFILE=" | + | IMAGEFILE=" |
- | | + | # ... and change the partition type to reflect the file system actually in use for partition 1 |
- | # (" | + | # (" |
- | sfdisk --part-type $IMAGEFILE 1 b | + | sfdisk --part-type $IMAGEFILE 1 b |
- | | + | # next, we need to patch two things inside the image, so we need to set up a loop device for it. |
- | FREELOOP=$(losetup -f) # note that this could become a TOCTOU issue if more than 1 process tries to use loop devices | + | FREELOOP=$(losetup -f) # note that this could become a TOCTOU issue if more than 1 process tries to use loop devices |
- | | + | # as the image is a full disk image containing a partition, we need to jump to the position where the first partition starts |
- | losetup -o 1048576 $FREELOOP $IMAGEFILE | + | losetup -o 1048576 $FREELOOP $IMAGEFILE |
- | | + | # now let's mount it |
- | mkdir -p ./ | + | mkdir -p ./ |
- | mount $FREELOOP ./tempmount | + | mount $FREELOOP ./tempmount |
- | | + | # purge this dir, so we have enough space; we'll return to fill it later |
- | rm ./ | + | rm ./ |
- | | + | # first, we copy the contents of the boot/ |
- | # see if inplace helps against out of space errors | + | # see if inplace helps against out of space errors |
- | rsync -aP --inplace ./ | + | rsync -aP --inplace ./ |
- | | + | mkdir -p ./ |
- | rsync -aP ./ | + | rsync -aP ./ |
- | | + | # next, we replace the " |
- | sed -e ' | + | sed -e ' |
- | | + | # here comes the cleanup part |
- | sync | + | sync |
- | umount $FREELOOP | + | umount $FREELOOP |
- | losetup -d $FREELOOP | + | losetup -d $FREELOOP |
- | rmdir ./ | + | rmdir ./ |
- | fi | + | fi |
if [ " | if [ " | ||
Line 948: | Line 1027: | ||
* '' | * '' | ||
* '' | * '' | ||
- | * '' | + | * '' |
* '' | * '' | ||
* '' | * '' | ||
Line 968: | Line 1047: | ||
* '' | * '' | ||
* '' | * '' | ||
+ | * '' | ||
* '' | * '' | ||
* '' | * '' | ||
Line 984: | Line 1064: | ||
* '' | * '' | ||
* '' | * '' | ||
+ | |||
+ | ===== Client Branding/ | ||
+ | It is possible to make X2Go-TCE-Live match your Corporate Design/ | ||
+ | This is actually a feature of X2GoClient itself, so it will also work on //fat client// installations, | ||
===== Querying X2Go-TCE version info ===== | ===== Querying X2Go-TCE version info ===== |