Skip to content

Commit

Permalink
Publish 1.16
Browse files Browse the repository at this point in the history
  • Loading branch information
@gordonb3
gordonb3 committed May 4, 2023
1 parent 741f82b commit cce884d
Show file tree
Hide file tree
Showing 3 changed files with 671 additions and 640 deletions.
40 changes: 24 additions & 16 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,38 +1,38 @@
# bubbagen

Bootable live-USB of Bubba OS for the Excito B3 miniserver, build on Gentoo (kernel 5.15.41 - Gentoo stable)
Bootable live-USB of Bubba OS for the Excito B3 miniserver, build on Gentoo (kernel 6.1.12 - Gentoo stable)

## Description

<img src="https://raw.githubusercontent.com/gordonb3/cache/master/Bubba/Excito-B3.jpg" alt="Excito B3" width="250px" align="right"/>
This project is a spin-off from [Sakaki's gentoo-on-b3 project](https://github.com/sakaki-/gentoo-on-b3) and contains what was previously published as the `Special Edition` while the Bubba overlay was still in beta.<br><br>

As with the original, this project contains a bootable, live-USB image for the Excito B3 miniserver. You can use it as a rescue disk, to play with Gentoo Linux, or as the starting point to install Gentoo Linux on your B3's main hard drive. You can even use it on a diskless B3. No soldering, compilation, or [U-Boot](http://www.denx.de/wiki/U-Boot/WebHome) flashing is required! You can run it without harming your B3's existing software; however, any changes you make while running the system *will* be saved to the USB (i.e., there is persistence).
As with the original, this project contains a bootable, live-USB image for the Excito B3 miniserver. You can use it as a rescue disk, to play with Gentoo Linux, or as the starting point to install Gentoo Linux on your B3's main hard drive. You can even use it on a diskless B3. No soldering, compilation, or [U-Boot](https://www.denx.de/project/u-boot/) flashing is required! You can run it without harming your B3's existing software; however, any changes you make while running the system *will* be saved to the USB (i.e., there is persistence).

The kernel used in the image is **5.15.41** from gentoo-sources, with the necessary code to temporarily switch off the L2 cache in early boot (per [this link](https://lists.debian.org/debian-boot/2012/08/msg00804.html)) prepended, and the kirkwood-b3 device tree blob appended.
The kernel used in the image is **6.1.12** from gentoo-sources, with the necessary code to temporarily switch off the L2 cache in early boot (per [this link](https://lists.debian.org/debian-boot/2012/08/msg00804.html)) prepended, and the kirkwood-b3 device tree blob appended.

The image may be downloaded from the link below and should work, without modification, whether your B3 has an internal hard drive fitted or not.

Variant | Init type | Version | Image
:--- | ---: | ---: | ---:
B3 with or without Internal Drive | openRC | 1.15.0 | [bubbagenb3img-1.15.0.xz](https://github.com/gordonb3/bubbagen/releases/download/v1.15/bubbagenb3img-1.15.0.xz)
B3 with or without Internal Drive | systemd | 1.15.5 | [bubbagenb3img-1.15.5.xz](https://github.com/gordonb3/bubbagen/releases/download/v1.15/bubbagenb3img-1.15.5.xz)
B3 with or without Internal Drive | openRC | 1.16.0 | [bubbagenb3img-1.16.0.xz](https://github.com/gordonb3/bubbagen/releases/download/v1.16/bubbagenb3img-1.16.0.xz)
B3 with or without Internal Drive | systemd | 1.16.5 | [bubbagenb3img-1.16.5.xz](https://github.com/gordonb3/bubbagen/releases/download/v1.16/bubbagenb3img-1.16.5.xz)

> Please read the instructions below before proceeding. Also please note that all images are provided 'as is' and without warranty.
## Prerequisites

To try this out, you will need:
* A USB key of at least 8GB capacity (the *uncompressed* image is 14,813,184 (512 byte) sectors = 7,584,350,208 bytes). Unfortunately, not all USB keys work with the various versions of [U-Boot](http://www.denx.de/wiki/U-Boot/WebHome) that were factory installed on the B3. Most SanDisk and Lexar USB keys appear to work reliably, but others (e.g., Verbatim keys) will not boot properly. (You may find the list of known-good USB keys [in this post](http://forum.doozan.com/read.php?2,1915,page=1) useful.)
* A USB key of at least 8GB capacity (the *uncompressed* image is 14,813,184 (512 byte) sectors = 7,584,350,208 bytes). Unfortunately, not all USB keys work with the various versions of [U-Boot](https://www.denx.de/project/u-boot/) that were factory installed on the B3. Most SanDisk and Lexar USB keys appear to work reliably, but others (e.g., Verbatim keys) will not boot properly. (You may find the list of known-good USB keys [in this post](https://forum.doozan.com/read.php?2,1915,page=1) useful.)
* An Excito B3 (obviously!).
* A PC to decompress the image and write it to the USB key (of course, you can also use your B3 for this, assuming it is currently running the standard Excito / Debian Squeeze system). This is most easily done on a Linux machine of some sort, but tools are also available for Windows (see [here](http://tukaani.org/xz/) and [here](http://sourceforge.net/projects/win32diskimager/), for example). In the instructions below I'm going to assume you're using Linux.
* A PC to decompress the image and write it to the USB key (of course, you can also use your B3 for this, assuming it is currently running the standard Excito / Debian Squeeze system). This is most easily done on a Linux machine of some sort, but tools are also available for Windows (see [here](https://tukaani.org/xz/) and [here](https://sourceforge.net/projects/win32diskimager/), for example). In the instructions below I'm going to assume you're using Linux.


## Downloading and Writing the Image

On your Linux box, issue:
```
# wget -c https://github.com/gordonb3/bubbagen/releases/download/v1.15/bubbagenb3img-1.15.0.xz
# wget -c https://github.com/gordonb3/bubbagen/releases/download/v1.16/bubbagenb3img-1.16.0.xz
```
to fetch the compressed disk image file

Expand All @@ -41,7 +41,7 @@ Next, insert (into your Linux box) the USB key on which you want to install the
> **Warning** - this will *destroy* all existing data on the target drive, so please double-check that you have the path correct!
```
# xzcat bubbagenb3img-1.15.0.xz > /dev/sdX && sync
# xzcat bubbagenb3img-1.16.0.xz > /dev/sdX && sync
```

Substitute the actual USB key device path, for example `/dev/sdc`, for `/dev/sdX` in the above command. Make sure to reference the device, **not** a partition within it (so e.g., `/dev/sdc` and not `/dev/sdc1`; `/dev/sdd` and not `/dev/sdd1` etc.)
Expand Down Expand Up @@ -93,22 +93,30 @@ If you have previously connected to a *different* machine with the *same* IP add
## Using Gentoo

For the main text on this, please refer to the [older README](https://github.com/gordonb3/bubbagen/blob/v1.15/reference/gentoo-on-b3-1.8.0-README.md) by Sakaki.
For the main text on this, please refer to the [older README](https://github.com/gordonb3/bubbagen/blob/v1.16/reference/gentoo-on-b3-1.8.0-README.md) by Sakaki.


The following major changes to the original 1.8.0 release from Sakaki apply:

1. Both 1.15.x images now use the same generic kernel that is loaded through a second stage bootloader that allows you to change kernel command line parameters by simply editing a `boot.ini` file.
1. Both 1.16.x images now use the same generic kernel that is loaded through a second stage bootloader that allows you to change kernel command line parameters by simply editing a `boot.ini` file.

2. The image supplied kernel is version 5.15.41 and supports both openrc and systemd init systems.
2. The image supplied kernel is version 6.1.12 and supports both openrc and systemd init systems.

1. Both 1.15.x images have been brought up to date against the Gentoo tree as of 21 Aug 2022. The full set of packages in the image may be viewed [here (1.15.0)](https://github.com/gordonb3/bubbagen/blob/v1.15/reference/installed-packages-1.15.0) and [here (1.15.5)](https://github.com/gordonb3/bubbagen/blob/v1.15/reference/installed-packages-1.15.5).
1. Both 1.16.x images have been brought up to date against the Gentoo tree as of 21 Aug 2022. The full set of packages in the image may be viewed [here (1.16.0)](https://github.com/gordonb3/bubbagen/blob/v1.16/reference/installed-packages-1.16.0) and [here (1.16.5)](https://github.com/gordonb3/bubbagen/blob/v1.16/reference/installed-packages-1.16.5).

1. The bubbagen images have sysvinit patched to follow the hardware specific routine for shutting down. As such you can now simply use `halt` or `poweroff` commands (Sakaki's `poweroff-b3` script is not available in this image) to shut down the B3.
> Please note that the B3 does not actually power down but enters a special pre boot environment where it waits for the button on the rear to be pressed. As multiple users discovered, this happens to be pretty CPU intensive and the B3 may run quite hot and even use more power than when running an OS.
Have fun! ^-^

## Changes since version 1.15
* kernel: smaller core due to full revision of config, removing obsolete
* various developer language updates: gcc 12.2, perl 5.36, python 11
* fixed an issue with bubba-admin ebuild going into deadlock during post-install
* updated Logitech Media Server to the latest stable version 8.3.1
* re-added Tor anonymous communication router to @bubba set
* removed Easyfind client - service is due to be terminated in June 2023

## Changes since version 1.14

* fixed the old sakaki repos to conform to minimal EAPI requirements
Expand Down Expand Up @@ -167,15 +175,15 @@ Have fun! ^-^

* The image is subscribed to the following overlays:
* [`sakaki-tools`](https://github.com/sakaki-/sakaki-tools): this overlay (provided by Sakaki) provides the tools `showem` ([source](https://github.com/sakaki-/showem), [manpage](https://github.com/sakaki-/gentoo-on-b3/raw/master/reference/showem.pdf)) and `genup` ([source](https://github.com/sakaki-/genup), [manpage](https://github.com/sakaki-/gentoo-on-b3/raw/master/reference/genup.pdf)). (Note - these replace the old `showem-lite` and `genup-lite` tools.)
* [`gentoo-b3`](https://github.com/sakaki-/gentoo-b3-overlay): this overlay (provided by Sakaki) provides a modern version of the `lzo` package ([upstream](http://www.oberhumer.com/opensource/lzo/download/); required because of an [alignment bug](https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=757037#32)), and the `buildkernel-b3` tool ([source](https://github.com/sakaki-/buildkernel-b3), [manpage](https://github.com/sakaki-/gentoo-on-b3/raw/master/reference/buildkernel-b3.pdf)).
* [`gentoo-b3`](https://github.com/sakaki-/gentoo-b3-overlay): this overlay (provided by Sakaki) provides a modern version of the `lzo` package ([upstream](https://www.oberhumer.com/opensource/lzo/download/); required because of an [alignment bug](https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=757037#32)), and the `buildkernel-b3` tool ([source](https://github.com/sakaki-/buildkernel-b3), [manpage](https://github.com/sakaki-/gentoo-on-b3/raw/master/reference/buildkernel-b3.pdf)).
* [`bubba`](https://github.com/gordonb3/bubba-overlay): this overlay provides the `Bubba OS` and `Logitech Media Server`. It also provides ebuilds for the home automation software Domoticz and supporting software; these have not been installed in the image, but you can easily `emerge` them if you like.
* Please note that the firewall, as initially configured, will allow `ssh` traffic on the `wan` port also.
* Apart from Apache web server to run the Bubba User Interface, Samba file sharing is also enabled by default
* Tor is not installed on the bubbagen image because of licensing issues with openssl. You may install it yourself but you should note that this will trigger a rebuild of several other packages (including openssl and openssh - careful!)
* There is no MySQL in the bubbagen image. Reason? It consumes too much memory (YMMV). Original Excito Bubba OS Services that used it have either been adapted to use SQLite instead, or been replaced by alternatives. Webmail is now served by Roundcube and bubba-album was dropped in favor of Singapore Gallery (sgal).
* If you have a WiFi-enabled B3, the corresponding network interface is named `wlan0` (there is a `udev` rule that does this, namely `/lib/udev/rules.d/70-net-name-use-custom.rules`). Please note that this rule will **not** work correctly if you have more than one WiFi adaptor on your B3 (an unusual setup).
* The image includes a 1GiB swap partition, and also has sufficient space in its root partition to e.g., perform a kernel compilation, should you so desire.
* If you have a USB key larger than the minimum 8GB, after writing the image you can easily extend the size of the second partition (using `fdisk` and `resize2fs`), so you have more space to work in. See [these instructions](http://geekpeek.net/resize-filesystem-fdisk-resize2fs/), for example.
* If you have a USB key larger than the minimum 8GB, after writing the image you can easily extend the size of the second partition (using `fdisk` and `resize2fs`), so you have more space to work in. See [these instructions](https://geekpeek.net/resize-filesystem-fdisk-resize2fs/), for example.
* Postfix has been reconfigured to disallow starttls on the regular port 25. Use submission or ssmtp ports instead if you want to use relay from other than the lan interface.
* Emails to root (e.g. failed cron jobs) are forwarded to `admin`. Enable `Send and receive` and `IMAP` in the services tab to read them.

Expand Down Expand Up @@ -230,7 +238,7 @@ Once logged in, feel free to configure your system as you like! Of course, if yo

### Keeping Your Gentoo System Up-To-Date

Please refer to the corresponding section(s) in the [older README](https://github.com/gordonb3/bubbagen/blob/v1.15/reference/gentoo-on-b3-1.8.0-README.md) by Sakaki.
Please refer to the corresponding section(s) in the [older README](https://github.com/gordonb3/bubbagen/blob/v1.16/reference/gentoo-on-b3-1.8.0-README.md) by Sakaki.


### Upgrading from a previous version of Bubbagen
Expand Down
Loading

0 comments on commit cce884d

Please sign in to comment.