Files

T

Your Name 60718b360e feat: integrate precompiled hotspot binaries from x64_bin/ via pos network hotspot

2026-08-03 03:48:33 -04:00

10 KiB

Raw Blame History

Core Scripts Reference

Everything that runs during the bootstrap install: install.sh, preinstall.sh, postinstall.sh, the shared libraries, and features/. For the pos CLI tools see POS.md, for apps see APPS.md, for services see SYSTEMD.md.

install.sh — the orchestrator
preinstall.sh — system packages
postinstall.sh — user configuration
lib/common.sh — shared library
lib/flags.sh — feature flags
features/autostart.sh — boot-time feature
x64_bin/ — precompiled binaries

install.sh — the orchestrator

File: install.sh (run as ./install.sh) Purpose: the entry point. Coordinates all four install phases and the optional apps/features installs.

How it works

Pre-parse --no-color before anything else, so colors are disabled early (TERM=dumb is exported).
Source lib/common.sh (logging, run, spawn, …) and lib/flags.sh (feature flags).
Parse CLI options.
For each phase, should_run <num> <name> decides whether to run it:
- --skip <phase> removes a phase (takes precedence).
- --steps <spec> restricts the run to the listed phases only (1,3,4 or 1-3).
- Phase map: 1=preinstall, 2=scripts, 3=postinstall, 4=scalepoint (+ apps handled separately).

The phases:

#	Phase	Script/action
1	preinstall	`preinstall.sh` — apt packages + yt-dlp
2	scripts	Copies `bin/` → `/usr/local/bin/` (755), `lib/common.sh` + `lib/flags.sh` → `/usr/local/bin/` (644). Copies precompiled arch binaries from `x64_bin/` (or `arm64_bin/`) → `/usr/local/bin/`. With `--feature`: also installs `features/` (see below)
3	postinstall	`postinstall.sh` — PATH, completion, SSH keys, systemd
4	scalepoint	Shallow-clones ScaleTail templates to `/usr/local/share/linux_post_install/scale-tail`
5 (opt)	apps	`apps/install.sh` when `--apps` (interactive) or `--full` (all, non-interactive)

Precompiled arch binaries (Phase 2): install.sh picks the source folder from the machine architecture — x86_64 → x64_bin/, aarch64/arm64 → arm64_bin/ (added later) — and copies every file in it to /usr/local/bin/ (755). These are manually-compiled tools not available as internet builds (currently create_ap, wihotspot, wihotspot-gui). Dropping an arm64_bin/ folder later needs no code change.

Feature block (Phase 2, only with --feature): for every file in features/ it copies it to /usr/local/bin/<name>. If the destination already exists it asks "Overwrite existing …? [y/N]" (default keeps your file), then always sets the feature flag via flag_set (name derived as <filename without .sh>).

Configuration

No config file — everything is command-line:

Option	Effect
`--apps`	Run the interactive app picker after core install
`--full`	Core install + every app (non-interactive)
`--feature`	Install `features/` scripts to `/usr/local/bin/` (prompts on overwrite), sets their flags
`--dry-run`	Log every action instead of executing. Note: applies to `install.sh` itself; `postinstall.sh` runs as a subprocess and does not inherit `DRY_RUN`
`--skip <phase>`	Skip a phase (repeatable): `preinstall`, `scripts`, `postinstall`, `scalepoint`, `apps`
`--steps <spec>`	Run only listed phases: `1,3,4` or `1-3`
`--no-color`	Disable colored output
`-h`, `--help`	Show usage

preinstall.sh — system packages

File: preinstall.sh Purpose: Phase 1 — installs the base system packages and yt-dlp. Run: automatically by install.sh, or standalone with --dry-run.

How it works

apt update.
Installs the package list.
Downloads the latest yt-dlp binary to /usr/local/bin/yt-dlp and makes it executable.
Verifies a couple of tools (git --version, yt-dlp --version).

Configuration

The package list is the PACKAGES array:

PACKAGES=(
    git curl wget vim nano tmux tree jq
    unzip zip rsync htop btop telnet
    net-tools iputils-ping traceroute tcpdump nmap
    openssh-client openssh-server ufw fail2ban
    hostapd dnsmasq iptables iw
    ca-certificates gnupg lsb-release
    python3 python3-pip rclone
    libqrencode4 libgtk-3-0
)

Add or remove package names here. nmap and fail2ban are used later by pos network scan and postinstall.sh; hostapd, dnsmasq, iptables, iw and the GTK/Qr libs support the precompiled hotspot tools (see x64_bin/ — precompiled binaries).

postinstall.sh — user configuration

File: postinstall.sh (runs as your user) Purpose: Phase 3 — configures the user environment, SSH keys, and systemd services.

How it works

rclone config — if config/rclone.conf exists (gitignored), installs it to ~/.config/rclone/rclone.conf (600).
PATH — appends a PATH line to ~/.bashrc if not already present.
pos bash completion — installs completions/pos.bash to /usr/local/share/bash-completion/completions/ and sources it from ~/.bashrc.
SSH authorized keys — if config/authorized_keys exists, appends missing keys to ~/.ssh/authorized_keys (skips comments and duplicates, chmod 600).
systemd services — copies systemd/*.service to /etc/systemd/system/, daemon-reloads, then enables each service. autostart.service is only enabled when the autostart feature flag is set (see lib/flags.sh); otherwise it's skipped with a hint to run ./install.sh --feature.

Configuration

SSH keys: config/authorized_keys (one per line, gitignored).
rclone config: config/rclone.conf (gitignored).
The PATH line and completion line are embedded strings at the top of the file — edit there to change them.
The autostart flag (set by ./install.sh --feature) controls whether autostart.service gets enabled.

lib/common.sh — shared library

File: lib/common.sh (installed to /usr/local/bin/common.sh) Purpose: colors, logging, timers, spinners, dry-run-aware execution, and prompts. Sourced by most scripts.

How it works

Auto-disables colors when stdout is not a TTY. The run helper is the dry-run hook: scripts that want --dry-run support run every side-effecting command through run.

Configuration / API

Function	Purpose
`log "msg"`	Green `[+]` status line
`warn "msg"`	Yellow `[!]` warning
`err "msg"`	Red `ERROR:` line to stderr, then `exit 1`
`ok "msg"`	Green `OK` prefix line
`section "title"`	Cyan-bordered section header
`step N T "msg"`	Numbered step header (`[N/T] msg`)
`run cmd…`	Executes the command, or logs `(dry-run)` when `DRY_RUN=1`
`spawn "msg" cmd…`	Runs with an animated spinner + elapsed time; prints captured stderr and exits on failure
`timer_start` / `timer_stop`	Track and print elapsed time
`confirm "prompt" [default]`	Yes/no prompt; default `y` (`[Y/n]`) unless `n` given (`[y/N]`)

lib/flags.sh — feature flags

File: lib/flags.sh (installed to /usr/local/bin/flags.sh) Purpose: a system-wide, per-feature flag store. Flags mark features as installed/opted-in and gate behavior (e.g. systemd enablement) elsewhere.

How it works

One file per flag in $FLAGS_DIR. Presence = set, file content = optional value. Reads are plain file ops; writes go through run + sudo so they respect --dry-run. Installed by ./install.sh --feature; also usable directly:

source lib/flags.sh
flag_set autostart            # bare flag
flag_set app "2.1"            # flag with a value
flag_is_set autostart         # 0 if set, 1 if not
flag_value app                # prints "2.1"
flag_list                     # names of all set flags
flag_clear autostart

Configuration

Setting	Location
`FLAGS_DIR` (env)	Default `/usr/local/share/linux_post_install/flags` (dir 755, files 644). Overridable via environment for testing
CLI wrappers	`flag-reader`, `flag-set`, `flag-clear` (see POS.md)

features/autostart.sh — boot-time feature

File: features/autostart.sh (installed to /usr/local/bin/autostart.sh by ./install.sh --feature) Purpose: runs once at boot via autostart.service (only when the autostart flag is green) and logs basic connectivity status.

How it works

Appends timestamped lines to ~/.autostart.log:

[<date>] autostart running
[<date>] Network: online   # ping 8.8.8.8 succeeded
[<date>] autostart complete

Configuration

Log file: $HOME/.autostart.log (edit the LOG variable at the top).
The script is the one you're most likely to customize — this is exactly why it lives in features/ instead of bin/: a plain reinstall never overwrites your edits.

x64_bin/ — precompiled binaries

Folder: x64_bin/ (future: arm64_bin/) Purpose: manually-compiled tools that are not available as prebuilt binaries on the internet. install.sh copies them verbatim into /usr/local/bin/ on the matching architecture (see install.sh — the orchestrator).

File	Type	Purpose	Runtime deps
`create_ap`	bash script	Create a Wi-Fi access point from the CLI (NAT/Internet sharing)	`hostapd`, `dnsmasq`, `iptables`, `iw` (in `preinstall.sh`)
`wihotspot`	POSIX wrapper	Launches `wihotspot-gui` (path points at `/usr/local/bin/`)	—
`wihotspot-gui`	ELF x86-64	GTK3 GUI for the hotspot (QR code via libqrencode)	`libgtk-3-0`, `libqrencode4`

Configuration

Managed through the pos network hotspot command (see POS.md → network): hotspot launches the GUI; start/stop/status wrap create_ap.
Add a future arm64_bin/ folder with the same filenames and it is installed automatically on aarch64 machines — no install.sh change needed.

10 KiB

Raw Blame History

Core Scripts Reference

Table of contents

install.sh — the orchestrator

How it works

Configuration

preinstall.sh — system packages

How it works

Configuration

postinstall.sh — user configuration

How it works

Configuration

lib/common.sh — shared library

How it works

Configuration / API

lib/flags.sh — feature flags

How it works

Configuration

features/autostart.sh — boot-time feature

How it works

Configuration

x64_bin/ — precompiled binaries

Contents

Configuration

10 KiB Raw Blame History

Core Scripts Reference

Table of contents

install.sh — the orchestrator

How it works

Configuration

preinstall.sh — system packages

How it works

Configuration

postinstall.sh — user configuration

How it works

Configuration

lib/common.sh — shared library

How it works

Configuration / API

lib/flags.sh — feature flags

How it works

Configuration

features/autostart.sh — boot-time feature

How it works

Configuration

x64_bin/ — precompiled binaries

Contents

Configuration

10 KiB

Raw Blame History