Files
fips/packaging/systemd/install.sh
T
Johnathan Corgan 74e9d465a8 Add packaging subsystem with systemd tarball installer
Packaging directory structure:
- packaging/common/ — shared config (fips.yaml) used by all formats
- packaging/systemd/ — systemd-specific installer and service units

Systemd packaging includes:
- build-tarball.sh: builds release binaries and creates a self-contained
  install tarball with stripped binaries
- fips.service: systemd unit running the daemon with security hardening
- fips-dns.service: oneshot unit configuring resolvectl to route .fips
  domain queries to the FIPS DNS shim on 127.0.0.1:5354
- install.sh: deploys binaries to /usr/local/bin, installs systemd units,
  creates fips group for non-root control socket access
- uninstall.sh: removes service and binaries, optional --purge for
  config and identity key files
- README.install.md: installation and configuration guide

Default config enables UDP (2121), TCP inbound (8443), TUN, and DNS
resolver. Identity is ephemeral by default for privacy; operators can
uncomment persistent: true to maintain a stable npub for static peer
publishing. Ethernet transport is commented out for per-node setup.
2026-03-06 21:44:58 +00:00

148 lines
4.4 KiB
Bash
Executable File

#!/usr/bin/env bash
# FIPS Install Script
#
# Installs the FIPS mesh network daemon as a systemd service.
#
# Usage: sudo ./install.sh
#
# Files installed:
# /usr/local/bin/fips Daemon binary
# /usr/local/bin/fipsctl CLI query tool
# /usr/local/bin/fipstop TUI monitor
# /etc/fips/fips.yaml Configuration (preserved if exists)
# /etc/systemd/system/fips.service systemd unit
# /etc/systemd/system/fips-dns.service DNS routing for .fips domain
set -euo pipefail
INSTALL_PREFIX="/usr/local"
CONFIG_DIR="/etc/fips"
CONFIG_FILE="${CONFIG_DIR}/fips.yaml"
SYSTEMD_DIR="/etc/systemd/system"
FIPS_GROUP="fips"
SCRIPT_DIR="$(cd "$(dirname "$0")" && pwd)"
# --- Preflight checks ---
if [ "$(id -u)" -ne 0 ]; then
echo "Error: This script must be run as root (use sudo)." >&2
exit 1
fi
if [ ! -f "${SCRIPT_DIR}/fips" ]; then
echo "Error: fips binary not found in ${SCRIPT_DIR}" >&2
exit 1
fi
if ! command -v systemctl &>/dev/null; then
echo "Error: systemctl not found. This script requires systemd." >&2
exit 1
fi
if [ ! -e /dev/net/tun ]; then
echo "Warning: /dev/net/tun not found. TUN support may not work." >&2
echo " Load the module with: modprobe tun" >&2
fi
# --- Create fips group for control socket access ---
if ! getent group "${FIPS_GROUP}" &>/dev/null; then
groupadd --system "${FIPS_GROUP}"
echo "Created system group '${FIPS_GROUP}'."
fi
# --- Install binaries ---
echo "Installing binaries to ${INSTALL_PREFIX}/bin/"
install -m 0755 "${SCRIPT_DIR}/fips" "${INSTALL_PREFIX}/bin/fips"
install -m 0755 "${SCRIPT_DIR}/fipsctl" "${INSTALL_PREFIX}/bin/fipsctl"
if [ -f "${SCRIPT_DIR}/fipstop" ]; then
install -m 0755 "${SCRIPT_DIR}/fipstop" "${INSTALL_PREFIX}/bin/fipstop"
fi
# --- Install configuration ---
mkdir -p "${CONFIG_DIR}"
if [ -f "${CONFIG_FILE}" ]; then
echo "Configuration exists at ${CONFIG_FILE}, not overwriting."
install -m 0644 "${SCRIPT_DIR}/fips.yaml" "${CONFIG_DIR}/fips.yaml.template"
echo " New template installed as ${CONFIG_DIR}/fips.yaml.template"
else
install -m 0600 "${SCRIPT_DIR}/fips.yaml" "${CONFIG_FILE}"
echo "Configuration installed to ${CONFIG_FILE}"
fi
# --- Install systemd unit ---
was_active=false
if systemctl is-active --quiet fips.service 2>/dev/null; then
was_active=true
echo "Stopping running fips service..."
systemctl stop fips.service
fi
dns_was_active=false
if systemctl is-active --quiet fips-dns.service 2>/dev/null; then
dns_was_active=true
echo "Stopping running fips-dns service..."
systemctl stop fips-dns.service
fi
install -m 0644 "${SCRIPT_DIR}/fips.service" "${SYSTEMD_DIR}/fips.service"
install -m 0644 "${SCRIPT_DIR}/fips-dns.service" "${SYSTEMD_DIR}/fips-dns.service"
systemctl daemon-reload
echo "systemd units installed."
# --- Configure runtime directory group ownership ---
# systemd creates /run/fips/ with RuntimeDirectory, but we need the
# group set to 'fips' so group members can access the control socket.
# Create a tmpfiles.d entry for this.
cat > /etc/tmpfiles.d/fips.conf <<'TMPFILES'
d /run/fips 0750 root fips -
TMPFILES
echo "tmpfiles.d entry created for /run/fips/ ownership."
# --- Enable service ---
systemctl enable fips.service
systemctl enable fips-dns.service
echo "Services enabled (will start on boot)."
# Restart if they were running before
if $was_active; then
echo "Restarting fips service..."
systemctl start fips.service
fi
if $dns_was_active; then
echo "Restarting fips-dns service..."
systemctl start fips-dns.service
fi
echo ""
echo "=== Installation complete ==="
echo ""
echo "Before starting the service, edit ${CONFIG_FILE}:"
echo ""
echo " 1. Set a persistent identity (if publishing npub for static peers)"
echo " Uncomment 'persistent: true' in the identity section."
echo " A keypair will be generated and saved on first start."
echo ""
echo " 2. Configure Ethernet transport interface (if using)"
echo " Uncomment the ethernet section and set the interface name."
echo ""
echo " 3. Add static peers (if bootstrapping over UDP/TCP)"
echo ""
echo "Start the service:"
echo " sudo systemctl start fips"
echo ""
echo "Monitor:"
echo " sudo journalctl -u fips -f"
echo " fipsctl show status"
echo " fipstop"
echo ""
echo "To use fipsctl/fipstop without sudo, add your user to the fips group:"
echo " sudo usermod -aG fips \$USER"
echo " (log out and back in for group membership to take effect)"