1014dd6e42
A peer is a named reference to another LibrePortal instance. Phase 2 only
implements kind=backup-channel (friendly label over a hostname that shows
up in a shared backup repo); direct-ssh-direct and direct-ssh-via-relay
(Connect's blind-relay) are reserved enum values for Phase 3.
DB schema (db_create_tables.sh):
CREATE TABLE peers (
id INTEGER PRIMARY KEY AUTOINCREMENT,
name TEXT UNIQUE NOT NULL,
kind TEXT NOT NULL DEFAULT 'backup-channel',
config_json TEXT NOT NULL DEFAULT '{}',
status TEXT DEFAULT 'unknown',
last_seen TEXT,
created_at TEXT DEFAULT CURRENT_TIMESTAMP
);
+ indexes on name and kind.
config_json is kind-specific so new transports don't need a schema
migration. For backup-channel it carries {"hostname":"","loc_idx":N}.
Bash module (scripts/peer/):
peer_helpers.sh _peerDb, peerSqlEscape, peerValidateName/Kind.
peer_add.sh peerAdd <name> <kind> [k=v ...] → INSERT, refresh
generator. Rejects unimplemented kinds early so users
don't create dead-end peer records.
peer_remove.sh peerRemove <name> → DELETE.
peer_list.sh peerList → JSON array; peerGet, peerNameForHostname
(reverse-lookup for the migrate-tab overlay).
peer_check.sh peerCheckReachable, peerCheckAll. For backup-channel
'reachable' = at least one snapshot from that hostname
visible in (preferred|any enabled) location. Updates
status + last_seen so UI dots render without re-probing.
CLI (scripts/cli/commands/peer/):
libreportal peer list
libreportal peer get <name>
libreportal peer add <name> backup-channel hostname=<host> [loc_idx=<n>]
libreportal peer remove <name>
libreportal peer check [name]
Auto-routed by cli_initialize.sh's category-discovery.
WebUI data generator (scripts/webui/data/generators/peers/webui_peers.sh):
Emits data/peers/generated/peers.json with the peerList output and a
generated_at envelope. Hooked into webuiLibrePortalUpdate alongside the
backup generators.
Frontend:
- New top-level /peers route in spa.js (PeersPage class, peers-content.html).
- 'Peers' nav item in the topbar between Backups and the right-side controls.
- Add-peer modal with friendly-name + kind + hostname + preferred-location
selector (populated from the existing backup-locations data).
- Per-peer card with status dot, last-checked time, Check + Remove buttons.
- Phase 3 kinds appear in the kind dropdown as disabled options so users
can see what's coming.
Source-array wiring:
- generate_arrays.sh auto-created files_peer.sh from the new peer/ dir.
- cli_files.sh + app_files.sh include ${peer_scripts[@]} alphabetically.
- files_webui.sh auto-picked-up the new peers/ generator subfolder.
The migrate-tab friendly-name overlay (use peer names in /backup/migrate
when a peer record exists for a hostname) is intentionally deferred — it's
a 5-line frontend lookup once peers.json is loaded; cleaner to add after
Phase 3 ships its peer-detail view.
Signed-off-by: librelad <librelad@digitalangels.vip>
83 lines
3.0 KiB
Bash
83 lines
3.0 KiB
Bash
#!/bin/bash
|
|
|
|
# Reachability check for a peer. The meaning of "reachable" depends on kind:
|
|
# backup-channel At least one snapshot from this peer's hostname is
|
|
# visible in the configured location within the last
|
|
# 30 days (or ever, if it's just been added).
|
|
# direct-ssh-direct SSH connect + 'peer-shell ping' (Phase 3).
|
|
# direct-ssh-via-relay Open relay session + 'peer-shell ping' (Phase 3b).
|
|
#
|
|
# Updates the peer's status + last_seen columns on success/failure so the UI
|
|
# can render a colored dot without re-running the check on every page load.
|
|
|
|
peerCheckReachable()
|
|
{
|
|
local name="$1"
|
|
if [[ -z "$name" ]]; then isError "peerCheckReachable: name required"; return 1; fi
|
|
|
|
local row
|
|
row=$(sqlite3 "$(_peerDb)" "SELECT id, kind, config_json FROM peers WHERE name='$(peerSqlEscape "$name")';" 2>/dev/null)
|
|
if [[ -z "$row" ]]; then
|
|
isError "No peer named '$name'"
|
|
return 1
|
|
fi
|
|
|
|
local id kind cfg
|
|
IFS='|' read -r id kind cfg <<< "$row"
|
|
|
|
local new_status="unknown"
|
|
local now
|
|
now=$(date -Iseconds)
|
|
|
|
case "$kind" in
|
|
backup-channel)
|
|
local hostname loc_idx
|
|
hostname=$(printf '%s' "$cfg" | grep -o '"hostname":"[^"]*"' | head -1 | cut -d'"' -f4)
|
|
loc_idx=$(printf '%s' "$cfg" | grep -o '"loc_idx":[0-9]*' | head -1 | cut -d':' -f2)
|
|
if [[ -z "$hostname" ]]; then
|
|
new_status="config-error"
|
|
elif [[ -z "$loc_idx" ]]; then
|
|
# No preferred location — try any enabled location.
|
|
local found=""
|
|
while IFS= read -r idx; do
|
|
[[ -z "$idx" ]] && continue
|
|
if engineSnapshotsJson "$idx" "" "$hostname" 2>/dev/null | grep -q '"short_id":'; then
|
|
found="$idx"; break
|
|
fi
|
|
done < <(resticEnabledLocations)
|
|
[[ -n "$found" ]] && new_status="ok" || new_status="no-snapshots"
|
|
else
|
|
if engineSnapshotsJson "$loc_idx" "" "$hostname" 2>/dev/null | grep -q '"short_id":'; then
|
|
new_status="ok"
|
|
else
|
|
new_status="no-snapshots"
|
|
fi
|
|
fi
|
|
;;
|
|
direct-ssh-direct|direct-ssh-via-relay)
|
|
new_status="not-yet-implemented"
|
|
;;
|
|
*)
|
|
new_status="unknown-kind"
|
|
;;
|
|
esac
|
|
|
|
sqlite3 "$(_peerDb)" \
|
|
"UPDATE peers SET status='$(peerSqlEscape "$new_status")', last_seen='$now' WHERE id=$id;" 2>/dev/null
|
|
|
|
echo "$new_status"
|
|
[[ "$new_status" == "ok" ]]
|
|
}
|
|
|
|
# Check every peer; useful for the WebUI's "Refresh" button.
|
|
peerCheckAll()
|
|
{
|
|
local name
|
|
while IFS= read -r name; do
|
|
[[ -z "$name" ]] && continue
|
|
local status
|
|
status=$(peerCheckReachable "$name")
|
|
isNotice " $name → $status"
|
|
done < <(sqlite3 "$(_peerDb)" "SELECT name FROM peers ORDER BY name;" 2>/dev/null)
|
|
}
|