Skip to content

Latest commit

 

History

History
54 lines (35 loc) · 2.04 KB

README-CUSTOMIZATION.md

File metadata and controls

54 lines (35 loc) · 2.04 KB

Sbnb Linux Customization Using sbnb-cmds.sh

Overview

The sbnb-cmds.sh file introduces a powerful way to customize Sbnb Linux instances during boot. By placing a custom shell script named sbnb-cmds.sh on a USB flash drive or another supported configuration source, you can define commands and behaviors executed under the busybox shell during the boot process.

This feature is ideal for automating tasks, configuring system settings, or running services at startup.

How It Works

  1. During the boot process, Sbnb Linux scans for the sbnb-cmds.sh file on supported sources (e.g., USB flash drives).
  2. If found, the script is executed under the busybox shell.
  3. Users can define their custom commands within this script to tailor the instance’s behavior.

Example Script

Below is an example of a simple sbnb-cmds.sh script:

#!/bin/sh

# Get the script name
SCRIPT_NAME="$(basename "$0")"

# Function to print messages with script name prefix
log_message() {
    echo "[$SCRIPT_NAME] $1" > /dev/kmsg
}

# Print welcome message
log_message "Welcome to the system information script!"

# Start a Docker container with Alpine and echo Hello, World!
log_message "Starting a Docker container with 'alpine' to echo Hello, World!:"
docker run alpine echo "Hello, World!" | while read -r line; do
    log_message "$line"
done

Notes on sbnb-tskey.txt

The existing functionality for processing the sbnb-tskey.txt file remains unchanged. This means that:

  • The sbnb-tskey.txt file is still processed as part of the boot sequence.
  • Users who prefer to omit the sbnb-tskey.txt file can include a full custom Tailscale up command with their desired arguments directly in the sbnb-cmds.sh file.

Usage Instructions

  1. Create a sbnb-cmds.sh file using the example above or your custom commands.
  2. Place the script on a USB flash drive or another supported configuration source.
  3. Boot the Sbnb Linux instance with the USB drive connected.
  4. Verify the output in the system logs or the console to ensure the script executed as expected.