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>
71 lines
2.2 KiB
Bash
71 lines
2.2 KiB
Bash
#!/bin/bash
|
|
|
|
# Add a peer record. Caller provides name + kind + a key=value config blob
|
|
# that's serialised into the config_json column.
|
|
#
|
|
# Usage:
|
|
# peerAdd <name> <kind> [key1=val1] [key2=val2] ...
|
|
#
|
|
# Example (backup-channel — Phase 1/2):
|
|
# peerAdd homelab backup-channel hostname=homelab.local loc_idx=1
|
|
|
|
peerAdd()
|
|
{
|
|
local name="$1"; shift
|
|
local kind="$1"; shift
|
|
|
|
local nv; nv=$(peerValidateName "$name")
|
|
if [[ "$nv" != "ok" ]]; then
|
|
isError "Invalid peer name: $nv"
|
|
return 1
|
|
fi
|
|
local kv; kv=$(peerValidateKind "$kind")
|
|
if [[ "$kv" != "ok" ]]; then
|
|
isError "Cannot use kind '$kind' yet: $kv"
|
|
return 1
|
|
fi
|
|
|
|
# Already exists?
|
|
local existing
|
|
existing=$(sqlite3 "$(_peerDb)" "SELECT id FROM peers WHERE name='$(peerSqlEscape "$name")';" 2>/dev/null)
|
|
if [[ -n "$existing" ]]; then
|
|
isError "Peer '$name' already exists (id=$existing). Use 'peer update' or 'peer remove' first."
|
|
return 1
|
|
fi
|
|
|
|
# Build the JSON blob from key=value args. We don't pull in jq; values are
|
|
# JSON-escaped inline (only handles strings and bare numerics, which is
|
|
# what the kind-specific schemas need today).
|
|
local first=1
|
|
local cfg='{'
|
|
local kv_pair k v
|
|
for kv_pair in "$@"; do
|
|
k="${kv_pair%%=*}"
|
|
v="${kv_pair#*=}"
|
|
[[ -z "$k" || "$k" == "$kv_pair" ]] && continue # not a key=value
|
|
local rendered
|
|
if [[ "$v" =~ ^-?[0-9]+(\.[0-9]+)?$ ]]; then
|
|
rendered="$v"
|
|
else
|
|
local esc="${v//\\/\\\\}"; esc="${esc//\"/\\\"}"
|
|
rendered="\"$esc\""
|
|
fi
|
|
if (( first )); then cfg+="\"$k\":$rendered"; first=0
|
|
else cfg+=",\"$k\":$rendered"; fi
|
|
done
|
|
cfg+='}'
|
|
|
|
sqlite3 "$(_peerDb)" \
|
|
"INSERT INTO peers (name, kind, config_json) VALUES ('$(peerSqlEscape "$name")', '$(peerSqlEscape "$kind")', '$(peerSqlEscape "$cfg")');" 2>/dev/null
|
|
|
|
if [[ $? -eq 0 ]]; then
|
|
isSuccessful "Peer '$name' added (kind=$kind)"
|
|
# Refresh WebUI cache if the generator is loaded.
|
|
declare -F webuiGeneratePeers >/dev/null 2>&1 && webuiGeneratePeers >/dev/null 2>&1 || true
|
|
return 0
|
|
else
|
|
isError "Failed to insert peer '$name'"
|
|
return 1
|
|
fi
|
|
}
|