feat: interactive per-key conflict resolution in update.sh's config sync
Replaces the previous commit's blind force-overwrite with a real choice, per user feedback: force-overwriting server config without asking was the wrong default. - A tracked config value (real default in .env.example) that already matches .env is left alone silently — no prompt, no noise. - A value that DIFFERS is a conflict, shown on one screen (all conflicts together, not one prompt per key) via gum (charmbracelet/gum) — single static binary fetched as a release tarball into .cache/gum/ (gitignored), no build step, no package manager dependency. Falls back to a plain read-based prompt if gum can't be fetched (offline, unsupported arch). - Non-interactive (no TTY — cron, CI, piped): any conflict is a hard error (exit 1, lists every conflicting key) unless --force is passed, which accepts every new value automatically — matches how this PR's own fix needs to land unattended. - Secrets and host-resolved values are completely unaffected either way — untouched by this loop, same as before. Verified in an isolated sandbox against the exact scenario from this PR (stale LLAMA_FAST_PARALLEL=2 vs git's 1): - no TTY, no --force: exits 1, prints the diff, doesn't touch .env - no TTY, --force: LLAMA_FAST_PARALLEL corrected 2 -> 1, an OMNIROUTE secret confirmed untouched (not regenerated) docker compose config -q still passes. Not verified: the interactive gum path itself (needs a real TTY, couldn't allocate a pty in this sandbox) — worth confirming for real on the server, including that gum's release asset naming actually matches what ensure_gum() expects. Refs #5
This commit is contained in:
@@ -4,3 +4,4 @@
|
||||
# to be committed to this repo.
|
||||
data/
|
||||
.leankg/
|
||||
.cache/
|
||||
|
||||
+111
-21
@@ -5,11 +5,16 @@
|
||||
# changed — safe to run any time, including with nothing to do.
|
||||
#
|
||||
# Tunable config values (LLAMA_*, ports, timeouts — anything with a real
|
||||
# default in .env.example) are force-synced from .env.example every run,
|
||||
# not just filled in when missing — see the sync loop below. Only actual
|
||||
# secrets and host-resolved values (blank in .env.example) survive a
|
||||
# server-side edit; there's no persistent server-only override for
|
||||
# anything else.
|
||||
# default in .env.example) are synced from .env.example every run. A value
|
||||
# already matching is left alone silently. A value that DIFFERS from the
|
||||
# server's current .env is a conflict: interactively, you're shown every
|
||||
# conflict on one screen (via gum) and choose which to accept — unpicked
|
||||
# keys keep the server's current value. Non-interactively (no TTY — cron,
|
||||
# CI, piped), any conflict is a hard error unless --force is passed, which
|
||||
# accepts every new value automatically. Secrets and host-resolved values
|
||||
# (blank in .env.example — OMNIROUTE_*_SECRET/_KEY/_SALT/_PASSWORD,
|
||||
# SEARXNG_LAN_IP, COMFYUI_PUID/PGID, HOST_VIDEO_GID/RENDER_GID) are never
|
||||
# touched by this — they keep going through set_if_blank as before.
|
||||
#
|
||||
# omniroute's own routing/provider config (llama-server, search) lives in
|
||||
# its dashboard, not a checked-in file like the old litellm-config.yaml —
|
||||
@@ -21,6 +26,14 @@
|
||||
set -euo pipefail
|
||||
cd "$(dirname "$0")/.."
|
||||
|
||||
FORCE=false
|
||||
for arg in "$@"; do
|
||||
case "$arg" in
|
||||
--force) FORCE=true ;;
|
||||
*) echo "Usage: $0 [--force]" >&2; exit 1 ;;
|
||||
esac
|
||||
done
|
||||
|
||||
# Must run before anything else touches a file this script itself reads
|
||||
# (docker-compose.yml, .env.example, this script's own remaining lines) —
|
||||
# a self-updating script isn't guaranteed atomic against its own file
|
||||
@@ -35,28 +48,105 @@ git pull --ff-only
|
||||
[ -f .env ] || cp .env.example .env
|
||||
|
||||
echo "==> syncing tracked config values from .env.example"
|
||||
# Every KEY=VALUE line in .env.example that has a real default (not
|
||||
# blank) is ordinary tunable config, not a secret or host-specific
|
||||
# value — .env.example itself already draws that line: secrets
|
||||
# (OMNIROUTE_*_SECRET/_KEY/_SALT/_PASSWORD) and host-resolved values
|
||||
# (SEARXNG_LAN_IP, COMFYUI_PUID/PGID, HOST_VIDEO_GID/RENDER_GID) are
|
||||
# all left blank there on purpose, so this loop naturally skips them —
|
||||
# they keep going through set_if_blank below instead. This force-
|
||||
# overwrites .env with whatever's in git on every run, so a value
|
||||
# hand-edited on the server (not in .env.example) gets silently
|
||||
# reverted on the next update.sh — that's the point (git pull #48 bit
|
||||
# us exactly because a stale .env value survived a code change and
|
||||
# broke llama-server-fast, see #5/#49), but it means there's no such
|
||||
# thing as a persistent server-only override for these keys anymore.
|
||||
# ponytail: gum (charmbracelet/gum) is a single static binary, fetched as a
|
||||
# release tarball — no build step, no package-manager dependency. Cached
|
||||
# under .cache/gum/ (gitignored) so repeat runs don't re-download. Release
|
||||
# asset naming (gum_<ver>_Linux_<arch>.tar.gz) follows charm's standard
|
||||
# goreleaser convention but hasn't been exercised against a real download
|
||||
# on this exact host yet — if it 404s, check
|
||||
# https://github.com/charmbracelet/gum/releases for the current naming.
|
||||
GUM_VERSION="0.14.5"
|
||||
GUM_DIR="$(pwd)/.cache/gum"
|
||||
GUM_BIN="$GUM_DIR/gum"
|
||||
ensure_gum() {
|
||||
command -v gum >/dev/null 2>&1 && { echo "gum"; return; }
|
||||
[ -x "$GUM_BIN" ] && { echo "$GUM_BIN"; return; }
|
||||
mkdir -p "$GUM_DIR"
|
||||
local arch tmpdir url
|
||||
case "$(uname -m)" in
|
||||
x86_64) arch="x86_64" ;;
|
||||
aarch64|arm64) arch="arm64" ;;
|
||||
*) echo "no gum build for $(uname -m), falling back to plain prompts" >&2; echo ""; return ;;
|
||||
esac
|
||||
url="https://github.com/charmbracelet/gum/releases/download/v${GUM_VERSION}/gum_${GUM_VERSION}_Linux_${arch}.tar.gz"
|
||||
tmpdir="$(mktemp -d)"
|
||||
if curl -fsSL "$url" | tar -xz -C "$tmpdir" 2>/dev/null; then
|
||||
find "$tmpdir" -name gum -type f -exec cp {} "$GUM_BIN" \;
|
||||
chmod +x "$GUM_BIN" 2>/dev/null || true
|
||||
fi
|
||||
rm -rf "$tmpdir"
|
||||
[ -x "$GUM_BIN" ] && echo "$GUM_BIN" || echo ""
|
||||
}
|
||||
|
||||
# Collect every key where .env.example has a real (non-blank) default:
|
||||
# missing from .env -> just add it (no conflict, nothing to decide);
|
||||
# present and identical -> leave alone silently; present and different ->
|
||||
# a conflict to resolve below.
|
||||
conflict_keys=()
|
||||
conflict_old=()
|
||||
conflict_new=()
|
||||
while IFS='=' read -r key value; do
|
||||
[ -n "$value" ] || continue
|
||||
if grep -qE "^${key}=" .env; then
|
||||
sed -i "s|^${key}=.*|${key}=${value}|" .env
|
||||
else
|
||||
current="$(grep -E "^${key}=" .env | head -1 | cut -d= -f2-)"
|
||||
if ! grep -qE "^${key}=" .env; then
|
||||
echo "${key}=${value}" >> .env
|
||||
elif [ "$current" != "$value" ]; then
|
||||
conflict_keys+=("$key")
|
||||
conflict_old+=("$current")
|
||||
conflict_new+=("$value")
|
||||
fi
|
||||
done < <(grep -E '^[A-Za-z_][A-Za-z0-9_]*=.+' .env.example)
|
||||
|
||||
if [ "${#conflict_keys[@]}" -gt 0 ]; then
|
||||
if [ "$FORCE" = true ]; then
|
||||
for i in "${!conflict_keys[@]}"; do
|
||||
key="${conflict_keys[$i]}"; new="${conflict_new[$i]}"
|
||||
sed -i "s|^${key}=.*|${key}=${new}|" .env
|
||||
echo "${key}: ${conflict_old[$i]} -> ${new} (--force)"
|
||||
done
|
||||
elif [ ! -t 0 ] || [ ! -t 1 ]; then
|
||||
echo "ERROR: ${#conflict_keys[@]} config value(s) in .env differ from .env.example, and this isn't an interactive terminal:" >&2
|
||||
for i in "${!conflict_keys[@]}"; do
|
||||
echo " ${conflict_keys[$i]}: ${conflict_old[$i]} (current) vs ${conflict_new[$i]} (.env.example)" >&2
|
||||
done
|
||||
echo "Re-run interactively to choose per-key, or pass --force to accept every new value." >&2
|
||||
exit 1
|
||||
else
|
||||
gum_bin="$(ensure_gum)"
|
||||
labels=()
|
||||
for i in "${!conflict_keys[@]}"; do
|
||||
labels+=("${conflict_keys[$i]}: ${conflict_old[$i]} -> ${conflict_new[$i]}")
|
||||
done
|
||||
if [ -n "$gum_bin" ]; then
|
||||
selected="$(printf '%s\n' "${labels[@]}" | "$gum_bin" choose --no-limit --selected "$(printf '%s\n' "${labels[@]}" | paste -sd,)" --header "Config differs from .env.example — selected keys take the new value, unselected keep the server's current value:")"
|
||||
else
|
||||
# ponytail: plain-bash fallback if gum couldn't be fetched (offline,
|
||||
# unsupported arch) — same one-screen-of-conflicts idea, cruder UI.
|
||||
echo "Config differs from .env.example. Enter space-separated numbers to KEEP the server's current value (all others take the new value), or press enter to take every new value:"
|
||||
for i in "${!conflict_keys[@]}"; do
|
||||
echo " $((i+1))) ${labels[$i]}"
|
||||
done
|
||||
read -r -p "> " keep_nums
|
||||
selected=""
|
||||
for i in "${!conflict_keys[@]}"; do
|
||||
case " $keep_nums " in
|
||||
*" $((i+1)) "*) ;;
|
||||
*) selected="${selected}${labels[$i]}"$'\n' ;;
|
||||
esac
|
||||
done
|
||||
fi
|
||||
for i in "${!conflict_keys[@]}"; do
|
||||
key="${conflict_keys[$i]}"; new="${conflict_new[$i]}"
|
||||
if printf '%s\n' "$selected" | grep -qxF "${labels[$i]}"; then
|
||||
sed -i "s|^${key}=.*|${key}=${new}|" .env
|
||||
echo "${key}: ${conflict_old[$i]} -> ${new}"
|
||||
else
|
||||
echo "${key}: kept ${conflict_old[$i]} (server value)"
|
||||
fi
|
||||
done
|
||||
fi
|
||||
fi
|
||||
|
||||
# Handles all three cases: the KEY=value line is missing entirely (.env
|
||||
# predates that var being added to .env.example — sed can't fix what isn't
|
||||
# there, so this appends it), present but blank, or already set.
|
||||
|
||||
Reference in New Issue
Block a user