refactor: major overhaul and cleanup of the build environment

- Removed `.env.sample` and improved `.env` handling
- Deleted `translate.py` and replaced it with `translate-md.py`
- Refactored `readme.yml` to enhance translation and tagging workflow
- Updated `.gitignore` with new exclusions
- Major restructuring of `Dockerfile`, including improved ENV variables and layout
- Extended `create-env.sh` with interactive prompts and validation
- Improved error handling and structure in `docker-compose-wrapper`
- Expanded `docker-compose.yml` with new environment variables and network settings
- Moved and updated `init.sh`, `.bashrc`, and other files to `files/` directory
- Added new scripts: `show-env.sh` for better diagnostics and `terminal-splash.txt` for enhanced display

These changes optimize the build environment for improved stability and flexibility.
This commit is contained in:
2025-02-11 18:20:58 +01:00
parent f823e7e8ee
commit 7ab5a410d3
12 changed files with 818 additions and 371 deletions

172
files/.bashrc Normal file
View File

@@ -0,0 +1,172 @@
# ~/.bashrc: executed by bash(1) for non-login shells.
# see /usr/share/doc/bash/examples/startup-files (in the package bash-doc)
# for examples
# If not running interactively, don't do anything
case $- in
*i*) ;;
*) return;;
esac
# don't put duplicate lines or lines starting with space in the history.
# See bash(1) for more options
HISTCONTROL=ignoreboth
# append to the history file, don't overwrite it
shopt -s histappend
export HISTFILE=@HISTFILE@
# for setting history length see HISTSIZE and HISTFILESIZE in bash(1)
HISTSIZE=1000
HISTFILESIZE=2000
# check the window size after each command and, if necessary,
# update the values of LINES and COLUMNS.
shopt -s checkwinsize
# If set, the pattern "**" used in a pathname expansion context will
# match all files and zero or more directories and subdirectories.
#shopt -s globstar
# make less more friendly for non-text input files, see lesspipe(1)
#[ -x /usr/bin/lesspipe ] && eval "$(SHELL=/bin/sh lesspipe)"
# set variable identifying the chroot you work in (used in the prompt below)
if [ -z "${debian_chroot:-}" ] && [ -r /etc/debian_chroot ]; then
debian_chroot=$(cat /etc/debian_chroot)
fi
# set a fancy prompt (non-color, unless we know we "want" color)
case "$TERM" in
xterm-color|*-256color) color_prompt=yes;;
esac
# uncomment for a colored prompt, if the terminal has the capability; turned
# off by default to not distract the user: the focus in a terminal window
# should be on the output of commands, not on the prompt
#force_color_prompt=yes
if [ -n "$force_color_prompt" ]; then
if [ -x /usr/bin/tput ] && tput setaf 1 >&/dev/null; then
# We have color support; assume it's compliant with Ecma-48
# (ISO/IEC-6429). (Lack of such support is extremely rare, and such
# a case would tend to support setf rather than setaf.)
color_prompt=yes
else
color_prompt=
fi
fi
if [ "$color_prompt" = yes ]; then
PS1='\[\033[01;33m\]\u\[\033[01;33m\]@@LOCAL_HOSTNAME@\[\033[00m\]:\[\033[01;34m\]\w\[\033[00m\]\$ '
else
PS1='${debian_chroot:+($debian_chroot)}\u@@LOCAL_HOSTNAME@:\w\$ '
fi
unset color_prompt force_color_prompt
# If this is an xterm set the title to user@host:dir
case "$TERM" in
xterm*|rxvt*)
PS1="\[\e]0;${debian_chroot:+($debian_chroot)}\u@\h: \w\a\]$PS1"
;;
*)
;;
esac
# enable color support of ls and also add handy aliases
if [ -x /usr/bin/dircolors ]; then
test -r ~/.dircolors && eval "$(dircolors -b ~/.dircolors)" || eval "$(dircolors -b)"
alias ls='ls --color=auto'
#alias dir='dir --color=auto'
#alias vdir='vdir --color=auto'
#alias grep='grep --color=auto'
#alias fgrep='fgrep --color=auto'
#alias egrep='egrep --color=auto'
fi
# colored GCC warnings and errors
#export GCC_COLORS='error=01;31:warning=01;35:note=01;36:caret=01;32:locus=01:quote=01'
# some more ls aliases
#alias ll='ls -l'
#alias la='ls -A'
#alias l='ls -CF'
# Alias definitions.
# You may want to put all your additions into a separate file like
# ~/.bash_aliases, instead of adding them here directly.
# See /usr/share/doc/bash-doc/examples in the bash-doc package.
if [ -f ~/.bash_aliases ]; then
. ~/.bash_aliases
fi
# enable programmable completion features (you don't need to enable
# this, if it's already enabled in /etc/bash.bashrc and /etc/profile
# sources /etc/bash.bashrc).
if ! shopt -oq posix; then
if [ -f /usr/share/bash-completion/bash_completion ]; then
. /usr/share/bash-completion/bash_completion
elif [ -f /etc/bash_completion ]; then
. /etc/bash_completion
fi
fi
cd @START_PATH@
echo -e "--------------------------------------------------------------------"
while IFS= read -r line; do
echo -e "$line"
done < /etc/terminal-splash.txt
echo -e "--------------------------------------------------------------------"
echo -e "docker-buildenv: v@DOCKER_BUILDENV_VERSION@\t| @DOCKER_BUILDENV_GIT_URL@"
echo -e "buildenv: $(git -C @START_PATH@ describe --tags --long | sed -e 's/-g[0-9a-f]\{7,\}$//' -e 's/-\([0-9]\+\)$/.\1/')\t| @BUILDENV_GIT_URL@"
if [ -f /etc/os-release ]; then
PRETTY_NAME=$(grep '^PRETTY_NAME=' /etc/os-release | cut -d= -f2 | tr -d '"')
echo -e "OS-Version: $PRETTY_NAME"
fi
echo -e "Kernel-Version: $(uname -r)"
echo -e "Container-Hostname: $(hostname)"
echo -e "Container-IP: $(hostname -I | awk '{print $1}')"
echo -e "--------------------------------------------------------------------"
echo -e ""
convert_locale() {
local input_locale="$1"
echo "${input_locale%.*}:${input_locale%%_*}"
}
export LANG=@LANG@
export LANGUAGE=$(convert_locale $LANG)
export LC_ALL=$LANG
# Set the directory to check
DIR_TO_CHECK=@START_PATH@
# Detect system locale
LOCALE=$(locale | grep LANG= | cut -d= -f2 | cut -d_ -f1)
# Set link based on locale
if [[ "$LOCALE" == "de" ]]; then
LINK="https://github.com/tuxbox-neutrino/buildenv/blob/master/README-de.md#14-init-skript-ausf%C3%BChren"
else
LINK="https://github.com/tuxbox-neutrino/buildenv/blob/master/README-us.md#14-init-script"
fi
# Check for subdirectories starting with 'meta-'
if ! find "$DIR_TO_CHECK" -type d -name "meta-*" | grep -q .; then
# Print bold and user-friendly message if no subdirectory matches
echo -e "--------------------------------------------------------------"
echo -e "\033[1m\033[33mNOTE: Your build environment seems to be uninitialized!\033[0m"
echo -e "--------------------------------------------------------------"
echo -e "\033[1mPlease run the init script to set up your environment.\033[0m"
echo -e ""
echo -e "./init && cd poky-@BUILDENV_VERSION@"
echo -e ""
echo -e "--------------------------------------------------------------"
echo -e "Refer to the instructions here:"
echo -e "\033[4m$LINK\033[0m"
echo -e ""
fi

120
files/init.sh Executable file
View File

@@ -0,0 +1,120 @@
#!/bin/bash
# Initialize tuxbox-builder container...
echo 'Initialize tuxbox-builder container...'
# Define a dedicated user group
GROUP_NAME="${USER_GROUP:-$USER}"
# Ensure the group exists, create it if necessary
if ! getent group "$GROUP_NAME" > /dev/null; then
echo "Group $GROUP_NAME does not exist. Creating..."
groupadd "$GROUP_NAME"
fi
# Ensure the user exists, create it if necessary
if ! id "$USER" &>/dev/null; then
echo "User $USER does not exist. Creating..."
useradd -m -s /bin/bash -g "$GROUP_NAME" -G www-data "$USER"
else
usermod -aG "$GROUP_NAME" "$USER"
usermod -aG www-data "$USER"
fi
# Prepare global Git configuration
mkdir -p "${XDG_CONFIG_HOME:-$USER_DIR/.config}/git"
echo 'Setting up global Git configuration...'
echo -e "[user]\n\temail = ${GIT_EMAIL}\n\tname = ${GIT_USER}" > "${XDG_CONFIG_HOME}/git/config"
chown -R "$USER":"$GROUP_NAME" "${XDG_CONFIG_HOME}/git"
# Prepare SSH configuration
mkdir -p "${USER_DIR}/.ssh"
# Optimize chown: Only change ownership if incorrect
for dir in "$USER_VOLUME_WORKDIR" "$WWW_DOCDIR"; do
if [ -d "$dir" ]; then
current_owner=$(stat -c "%U:%G" "$dir")
if [ "$current_owner" != "$USER:$GROUP_NAME" ]; then
echo "Updating ownership for $dir..."
chown -R "$USER":"$GROUP_NAME" "$dir"
fi
fi
done
# Optimize chmod: Only change permissions if incorrect
for dir in "$USER_VOLUME_WORKDIR" "$WWW_DOCDIR"; do
if [ -d "$dir" ]; then
if find "$dir" -not -perm -g+rw | grep . > /dev/null 2>&1; then
echo "Updating permissions for $dir..."
chmod -R g+rw "$dir"
fi
fi
done
echo "User $USER is set up with group $GROUP_NAME and www-data for shared access."
# Prepare build environment
if [ ! -d "${USER_VOLUME_WORKDIR}/${BUILDENV_PREFIX}/.git" ]; then
if cd "${USER_VOLUME_WORKDIR}"; then
echo "Cloning build environment repository..."
git clone "${BUILDENV_GIT_URL}" "${BUILDENV_PREFIX}"
else
echo "Error: Could not change directory to ${USER_VOLUME_WORKDIR}" >&2
exit 1
fi
else
echo "Repository [${USER_VOLUME_WORKDIR}/${BUILDENV_PREFIX}] already exists. Not modified!"
fi
chown -R "$USER":"$GROUP_NAME" "$USER_VOLUME_WORKDIR"
# Detect the build environment version
BUILDENV_DISTRO_VERSION=$(grep 'DEFAULT_IMAGE_VERSION=' "${START_PATH}/init.sh" | cut -d'=' -f2 | tr -d '"')
echo "Detected DISTRO_VERSION = $BUILDENV_DISTRO_VERSION within ${START_PATH}"
# Prepare web server content if enabled
if [ "${EXPLORER_ENABLE}" != "false" ]; then
if [ ! -d "${WWW_DOCDIR}/.git" ]; then
echo 'Cloning File Explorer web content repository...'
git clone "${EXPLORER_GIT_URL}" "${WWW_DOCDIR}"
fi
# Download default configuration file if it does not exist
if [ ! -f "${WWW_DOCDIR}/config/config.php" ]; then
echo "[${WWW_DOCDIR}/config/config.php] does not exist. Downloading..."
curl -o "${WWW_DOCDIR}/config/config.php" "https://raw.githubusercontent.com/dbt1/support/master/docker-buildenv/config-sample.php"
else
echo "Repository [${WWW_DOCDIR}] already exists and configured. Not modified!"
fi
# Find the build directory based on detected distro version
BUILD_DIR=$(find "${START_PATH}" -type d -path "*-${BUILDENV_DISTRO_VERSION}/build" ! -path "*-${BUILDENV_DISTRO_VERSION}/build/*" 2>/dev/null)
if [ -n "$BUILD_DIR" ]; then
sed -i "s|#@FILES_DIRECTORY@|\\\$FILES_DIRECTORY = '$BUILD_DIR'|g" "${WWW_DOCDIR}/config/config.php"
fi
chown -R "$USER":"$GROUP_NAME" "$WWW_DOCDIR"
else
echo "EXPLORER_ENABLE is disabled. Skipping web server setup."
fi
# Prepare user profile with environment variables
echo 'Configuring user profile...'
BASH_RC_FILE="${USER_DIR}/.bashrc"
sed -i "s|@START_PATH@|${START_PATH}|g" "$BASH_RC_FILE"
sed -i "s|@BUILDENV_GIT_URL@|${BUILDENV_GIT_URL}|g" "$BASH_RC_FILE"
sed -i "s|@DOCKER_BUILDENV_VERSION@|${DOCKER_BUILDENV_VERSION}|g" "$BASH_RC_FILE"
sed -i "s|@HISTFILE@|${HISTFILE}|g" "$BASH_RC_FILE"
sed -i "s|@LANG@|${LOCALE_LANG}|g" "$BASH_RC_FILE"
sed -i "s|@BUILDENV_VERSION@|${BUILDENV_DISTRO_VERSION}|g" "$BASH_RC_FILE"
sed -i "s|@DOCKER_BUILDENV_GIT_URL@|${DOCKER_BUILDENV_GIT_URL}|g" "$BASH_RC_FILE"
sed -i "s|@LOCAL_HOSTNAME@|${LOCAL_HOSTNAME}|g" "$BASH_RC_FILE"
chown "$USER":"$GROUP_NAME" "$BASH_RC_FILE"
# Mark container as ready
touch /tmp/container_ready
echo "Container setup complete. Ready to start services..."
echo "Enjoy...!"
# Start services using runsvdir
exec runsvdir -P /etc/service

44
files/show-env.sh Executable file
View File

@@ -0,0 +1,44 @@
#!/bin/bash
echo ""
echo "=== Environment Info for Normal Users, 'sshd', and 'root' ==="
echo ""
# Read all users from /etc/passwd
while IFS=: read -r username _ uid gid _ home _; do
# Include normal users (UID >= 1000), 'sshd', and 'root'
if [ "$uid" -ge 1000 ] || [ "$username" == "sshd" ] || [ "$username" == "root" ]; then
echo "User: $username"
echo "USER_ID: $uid"
echo "USER_GROUP: $(getent group $gid | cut -d: -f1)"
echo "USER_GROUP_ID: $gid"
# Git configuration, if available
if [ -f "$home/.gitconfig" ]; then
git_user=$(git config --global --file "$home/.gitconfig" user.name 2>/dev/null)
git_email=$(git config --global --file "$home/.gitconfig" user.email 2>/dev/null)
echo "GIT_USER: ${git_user:-Not configured}"
echo "GIT_EMAIL: ${git_email:-Not configured}"
fi
# Timezone, Locale, PATH, DISPLAY, and TERM
echo "TIMEZONE: $(cat /etc/timezone)"
if [ -d "$home" ]; then
locale_lang=$(LANG=$LANG HOME=$home bash -c 'echo $LANG' 2>/dev/null)
user_path=$(HOME=$home bash -c 'echo $PATH' 2>/dev/null)
display_var=$(HOME=$home bash -c 'echo $DISPLAY' 2>/dev/null)
term_var=$(HOME=$home bash -c 'echo $TERM' 2>/dev/null)
echo "LOCALE_LANG: ${locale_lang:-Not set}"
echo "PATH: ${user_path:-Not set}"
echo "DISPLAY: ${display_var:-Not set}"
echo "TERM: ${term_var:-Not set}"
echo "USER_HOME:"
# Limit tree output to 6 levels, max 3 directories per level
tree -L 6 -d "$home" | awk '{count[$1]++; if (count[$1] <= 3) print}'
fi
echo "-------------"
fi
done < /etc/passwd
echo "=== End of Environment Info ==="

10
files/terminal-splash.txt Normal file
View File

@@ -0,0 +1,10 @@
_____ ____ ____ _ _ _
|_ _| ___ _| __ ) _____ __ | __ ) _ _(_) | __| | ## .
| || | | \ \/ / _ \ / _ \ \/ / | _ \| | | | | |/ _` | ## ## ## ==
| || |_| |> <| |_) | (_) > < | |_) | |_| | | | (_| | ## ## ## ## ## ===
|_| \__,_/_/\_\____/ \___/_/\_\ |____/ \__,_|_|_|\__,_| /"""""""""""""""""\___/ ===
~~ ~~~~ ~~~ ~~~~ ~~~ ~~ ~~~~ ~~~ ~~~~ ~~~ ~~~ {~~ ~~~~ ~~~ ~~~~ ~~~ ~ / ===- ~~~
~~ ~~~~ ~~~ ~~~~ ~~~ \______ o __/
\ \ __/
\____\_______/