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>
49 lines
1.7 KiB
Bash
49 lines
1.7 KiB
Bash
#!/bin/bash
|
|
|
|
# Shared helpers for the peer subsystem. Peers are named other LibrePortal
|
|
# instances; rows live in the sqlite `peers` table (db_create_tables.sh).
|
|
#
|
|
# kind enum:
|
|
# backup-channel Friendly label over a hostname that shows up in a
|
|
# shared backup repo. No new networking — Phase 1/2.
|
|
# direct-ssh-direct Reachable peer over plain SSH (Phase 3).
|
|
# direct-ssh-via-relay Peer over Connect's blind relay (Phase 3b).
|
|
#
|
|
# config_json is kind-specific. For backup-channel:
|
|
# {"hostname":"homelab","loc_idx":1}
|
|
|
|
_peerDb() { echo "$docker_dir/$db_file"; }
|
|
|
|
# Quote a value for SQLite (escape single quotes by doubling). Stdin in,
|
|
# stdout out. Caller wraps the result in their own single quotes.
|
|
peerSqlEscape()
|
|
{
|
|
local s="$1"
|
|
printf "%s" "${s//\'/\'\'}"
|
|
}
|
|
|
|
# Validate that a string is a reasonable peer-name (alnum, dash, underscore,
|
|
# dot; 1..64 chars). Echo "ok" or the rejection reason; caller checks for "ok".
|
|
peerValidateName()
|
|
{
|
|
local name="$1"
|
|
if [[ -z "$name" ]]; then echo "empty"; return 1; fi
|
|
if [[ ${#name} -gt 64 ]]; then echo "too-long"; return 1; fi
|
|
if [[ ! "$name" =~ ^[A-Za-z0-9._-]+$ ]]; then echo "invalid-chars"; return 1; fi
|
|
echo "ok"
|
|
}
|
|
|
|
# Validate kind. Phase 2 only allows 'backup-channel'; the others are accepted
|
|
# at the schema level but the bash helpers reject them until Phase 3 ships
|
|
# their support to avoid users adding peers that nothing knows how to use.
|
|
peerValidateKind()
|
|
{
|
|
local kind="$1"
|
|
case "$kind" in
|
|
backup-channel) echo "ok" ;;
|
|
direct-ssh-direct|direct-ssh-via-relay)
|
|
echo "not-yet-implemented"; return 1 ;;
|
|
*) echo "unknown-kind"; return 1 ;;
|
|
esac
|
|
}
|