Initial Commit

.dockerignore

@@ -0,0 +1,5 @@
+output/
+work/
+deploy/
+apt-cacher-ng/
+.git/objects/*

.github/workflows/alpha-release.yml

@@ -0,0 +1,28 @@
+name: Alpha Release
+
+on:
+  workflow_dispatch:
+    inputs:
+      tag:
+        description: "Alpha version tag (1, 2, 3, ...)"
+        required: true
+
+jobs:
+  create-tag:
+    runs-on: ubuntu-latest
+    outputs:
+      tagname: ${{ steps.get_tag.outputs.tagname }}
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Get tag from config file
+        id: get_tag
+        run: |
+          VERSION=$(grep -oP '^RUNTIPI_OS_VERSION=\K[^ ]+' config)
+          TIPI_VERSION=$(curl -sL https://api.github.com/repos/runtipi/runtipi/releases/latest | grep tag_name | cut -d '"' -f4)
+          echo "tagname=v${VERSION}-tipi-${TIPI_VERSION}-alpha.${{ github.event.inputs.tag }}" >> $GITHUB_OUTPUT
+
+      # - uses: rickstaa/action-create-tag@v1
+      #   with:
+      #     tag: ${{ steps.get_tag.outputs.tagname }}

.gitignore

@@ -0,0 +1,8 @@
+deploy/*
+work/*
+postrun.sh
+SKIP
+SKIP_IMAGES
+.pc
+*-pc
+apt-cacher-ng/

Dockerfile

@@ -0,0 +1,16 @@
+ARG BASE_IMAGE=debian:bullseye
+FROM ${BASE_IMAGE}
+
+ENV DEBIAN_FRONTEND noninteractive
+
+RUN apt-get -y update && \
+    apt-get -y install --no-install-recommends \
+        git vim parted \
+        quilt coreutils qemu-user-static debootstrap zerofree zip dosfstools \
+        libarchive-tools libcap2-bin rsync grep udev xz-utils curl xxd file kmod bc\
+        binfmt-support ca-certificates qemu-utils kpartx fdisk gpg pigz\
+    && rm -rf /var/lib/apt/lists/*
+
+COPY . /pi-gen/
+
+VOLUME [ "/pi-gen/work", "/pi-gen/deploy"]

LICENSE

@@ -0,0 +1,13 @@
+Copyright (c) 2015 Raspberry Pi (Trading) Ltd.
+
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

README.md

@@ -0,0 +1,84 @@
+# Runtipi OS ⛺
+
+Runtipi OS is a simple operating system based on Debian Bookworm designed to make the experience of getting
+into the self-hosting world as easy as possible and of course as affordable as possible 💵.
+
+> Info 📖: This is a modified version of the raspberry pi [pi-gen](https://github.com/RPi-Distro/pi-gen) tool.
+> Warning ⚠️: This is still in development so issues are to be expected please open an issue for any bug you encounter.
+
+## Getting started 🚀
+
+You can install RunTipi on either of these two devices:
+
+- [Raspberry Pi 4 Model B](https://www.raspberrypi.com/products/raspberry-pi-4-model-b/)
+- [Raspberry Pi 3 Model B+](https://www.raspberrypi.com/products/raspberry-pi-3-model-b-plus/)
+
+> Support for raspberry pi 5 coming soon!
+
+> Note that the raspberry pi 4 is recommended due to having more ram so when buying choose 4gb of ram or more.
+
+### Instructions
+
+1. You will need these requirements to install Runtipi OS:
+   1. A raspberry pi 4 or 3 (of course 😉)
+   2. A 16gb or more SD card
+   3. An ethernet cable
+   4. A computer with an internet connection
+   5. An SD card reader
+   6. A case
+
+> A fan in the case would be also recommened you can find the official one [here](https://www.raspberrypi.com/products/raspberry-pi-4-case-fan/)
+
+2. Download the latest Runtipi OS image from the [releases page](https://github.com/runtipi/runtipi-raspberrypi/releases)
+
+3. Download and install Raspberry Pi Imager from [here](https://www.raspberrypi.com/software/)(https://www.raspberrypi.com/software/)Launch Raspberry Pi Imager and select your board. Then select the image you just downloaded and click the write button. The process will take about 5 minutes depending on your SD card.
+
+4. Insert the card into the Raspberry Pi, connect the ethernet cable and then the power cable. Wait around 10-15 minutes for it to download all the requirements and then access the dashboard by going to `tipi.local`.
+
+## SSH 💻
+
+SSH is enabled by default so you can see logs for any issues. Here are the credentials:
+
+- Hostname: `tipi.local`
+- User: `tipi`
+- Password: `letthatselfhostingroll`
+
+## Build the image yourself 🔨
+
+If you like, you can build the image yourself using these commands:
+
+1. Clone the repo
+
+```Bash
+git clone https://github.com/runtipi/runtipi-raspberrypi.git
+```
+
+2. Install requirements
+
+You will need both docker which you can install like this:
+
+```Bash
+curl -fsSL get.docker.com | sh
+```
+
+And now install the apt requirements:
+
+```Bash
+sudo apt install coreutils quilt parted qemu-user-static debootstrap zerofree zip \
+dosfstools libarchive-tools libcap2-bin grep rsync xz-utils file git curl bc \
+qemu-utils kpartx gpg pigz sed
+```
+
+3. Build
+
+To build the image cd into the repo and run this command:
+
+```Bash
+./build-docker.sh
+```
+
+This can take from 15 minutes to 30 minutes depending on your hardware and internet connection. When it is done you will have the image inside the `deploy/` folder.
+
+## Contributing ❤️
+
+This image is currently managed by one person (a teenager 😅) and it is hard to build and test every time. It would be extremely helpful for anyone interested in supporting this project to join our discord server [here](https://discord.gg/Bu9qEPnHsc) and help with the development of this project!

build-docker.sh

@@ -0,0 +1,169 @@
+#!/usr/bin/env bash
+# Note: Avoid usage of arrays as MacOS users have an older version of bash (v3.x) which does not supports arrays
+set -eu
+
+DIR="$(CDPATH='' cd -- "$(dirname -- "$0")" && pwd)"
+
+BUILD_OPTS="$*"
+
+# Allow user to override docker command
+DOCKER=${DOCKER:-docker}
+
+# Ensure that default docker command is not set up in rootless mode
+if \
+  ! ${DOCKER} ps    >/dev/null 2>&1 || \
+    ${DOCKER} info 2>/dev/null | grep -q rootless \
+; then
+	DOCKER="sudo ${DOCKER}"
+fi
+if ! ${DOCKER} ps >/dev/null; then
+	echo "error connecting to docker:"
+	${DOCKER} ps
+	exit 1
+fi
+
+CONFIG_FILE=""
+if [ -f "${DIR}/config" ]; then
+	CONFIG_FILE="${DIR}/config"
+fi
+
+while getopts "c:" flag
+do
+	case "${flag}" in
+		c)
+			CONFIG_FILE="${OPTARG}"
+			;;
+		*)
+			;;
+	esac
+done
+
+# Ensure that the configuration file is an absolute path
+if test -x /usr/bin/realpath; then
+	CONFIG_FILE=$(realpath -s "$CONFIG_FILE" || realpath "$CONFIG_FILE")
+fi
+
+# Ensure that the confguration file is present
+if test -z "${CONFIG_FILE}"; then
+	echo "Configuration file need to be present in '${DIR}/config' or path passed as parameter"
+	exit 1
+else
+	# shellcheck disable=SC1090
+	source ${CONFIG_FILE}
+fi
+
+CONTAINER_NAME=${CONTAINER_NAME:-pigen_work}
+CONTINUE=${CONTINUE:-0}
+PRESERVE_CONTAINER=${PRESERVE_CONTAINER:-0}
+PIGEN_DOCKER_OPTS=${PIGEN_DOCKER_OPTS:-""}
+
+if [ -z "${IMG_NAME}" ]; then
+	echo "IMG_NAME not set in 'config'" 1>&2
+	echo 1>&2
+exit 1
+fi
+
+# Ensure the Git Hash is recorded before entering the docker container
+GIT_HASH=${GIT_HASH:-"$(git rev-parse HEAD)"}
+
+CONTAINER_EXISTS=$(${DOCKER} ps -a --filter name="${CONTAINER_NAME}" -q)
+CONTAINER_RUNNING=$(${DOCKER} ps --filter name="${CONTAINER_NAME}" -q)
+if [ "${CONTAINER_RUNNING}" != "" ]; then
+	echo "The build is already running in container ${CONTAINER_NAME}. Aborting."
+	exit 1
+fi
+if [ "${CONTAINER_EXISTS}" != "" ] && [ "${CONTINUE}" != "1" ]; then
+	echo "Container ${CONTAINER_NAME} already exists and you did not specify CONTINUE=1. Aborting."
+	echo "You can delete the existing container like this:"
+	echo "  ${DOCKER} rm -v ${CONTAINER_NAME}"
+	exit 1
+fi
+
+# Modify original build-options to allow config file to be mounted in the docker container
+BUILD_OPTS="$(echo "${BUILD_OPTS:-}" | sed -E 's@\-c\s?([^ ]+)@-c /config@')"
+
+${DOCKER} build --build-arg BASE_IMAGE=debian:bullseye -t pi-gen "${DIR}"
+
+if [ "${CONTAINER_EXISTS}" != "" ]; then
+  DOCKER_CMDLINE_NAME="${CONTAINER_NAME}_cont"
+  DOCKER_CMDLINE_PRE="--rm"
+  DOCKER_CMDLINE_POST="--volumes-from=${CONTAINER_NAME}"
+else
+  DOCKER_CMDLINE_NAME="${CONTAINER_NAME}"
+  DOCKER_CMDLINE_PRE=""
+  DOCKER_CMDLINE_POST=""
+fi
+
+# Check if binfmt_misc is required
+binfmt_misc_required=1
+case $(uname -m) in
+  aarch64)
+    binfmt_misc_required=0
+    ;;
+  arm*)
+    binfmt_misc_required=0
+    ;;
+esac
+
+# Check if qemu-aarch64-static and /proc/sys/fs/binfmt_misc are present
+if [[ "${binfmt_misc_required}" == "1" ]]; then
+  if ! qemu_arm=$(which qemu-aarch64-static) ; then
+    echo "qemu-aarch64-static not found (please install qemu-user-static)"
+    exit 1
+  fi
+  if [ ! -f /proc/sys/fs/binfmt_misc/register ]; then
+    echo "binfmt_misc required but not mounted, trying to mount it..."
+    if ! mount binfmt_misc -t binfmt_misc /proc/sys/fs/binfmt_misc ; then
+        echo "mounting binfmt_misc failed"
+        exit 1
+    fi
+    echo "binfmt_misc mounted"
+  fi
+  if ! grep -q "^interpreter ${qemu_arm}" /proc/sys/fs/binfmt_misc/qemu-aarch64* ; then
+    # Register qemu-aarch64 for binfmt_misc
+    reg="echo ':qemu-aarch64-rpi:M::"\
+"\x7fELF\x02\x01\x01\x00\x00\x00\x00\x00\x00\x00\x00\x00\x02\x00\xb7\x00:"\
+"\xff\xff\xff\xff\xff\xff\xff\x00\xff\xff\xff\xff\xff\xff\xff\xff\xfe\xff\xff\xff:"\
+"${qemu_arm}:F' > /proc/sys/fs/binfmt_misc/register"
+    echo "Registering qemu-aarch64 for binfmt_misc..."
+    sudo bash -c "${reg}" 2>/dev/null || true
+  fi
+fi
+
+trap 'echo "got CTRL+C... please wait 5s" && ${DOCKER} stop -t 5 ${DOCKER_CMDLINE_NAME}' SIGINT SIGTERM
+time ${DOCKER} run \
+  $DOCKER_CMDLINE_PRE \
+  --name "${DOCKER_CMDLINE_NAME}" \
+  --privileged \
+  --cap-add=ALL \
+  -v /dev:/dev \
+  -v /lib/modules:/lib/modules \
+  ${PIGEN_DOCKER_OPTS} \
+  --volume "${CONFIG_FILE}":/config:ro \
+  -e "GIT_HASH=${GIT_HASH}" \
+  $DOCKER_CMDLINE_POST \
+  pi-gen \
+  bash -e -o pipefail -c "
+    dpkg-reconfigure qemu-user-static &&
+    # binfmt_misc is sometimes not mounted with debian bullseye image
+    (mount binfmt_misc -t binfmt_misc /proc/sys/fs/binfmt_misc || true) &&
+    cd /pi-gen; ./build.sh ${BUILD_OPTS} &&
+    rsync -av work/*/build.log deploy/
+  " &
+  wait "$!"
+
+# Ensure that deploy/ is always owned by calling user
+echo "copying results from deploy/"
+${DOCKER} cp "${CONTAINER_NAME}":/pi-gen/deploy - | tar -xf -
+
+echo "copying log from container ${CONTAINER_NAME} to depoy/"
+${DOCKER} logs --timestamps "${CONTAINER_NAME}" &>deploy/build-docker.log
+
+ls -lah deploy
+
+# cleanup
+if [ "${PRESERVE_CONTAINER}" != "1" ]; then
+	${DOCKER} rm -v "${CONTAINER_NAME}"
+fi
+
+echo "Done! Your image(s) should be in deploy/"