mirror of
https://github.com/lrnselfreliance/wrolpi.git
synced 2026-11-21 15:36:18 -05:00
* A WROLPi serves its library over rsync, and makes a database snapshot on request The first part of replacing the sync: a secondary will copy its primary's whole media directory with rsync and replace its database with the primary's, instead of downloading the files of FileGroups over HTTP (which never copies an ignored directory, such as the map's). - An rsync daemon serves the media directory read-only on port 8873, on every WROLPi. It never serves the TLS keys, the cookies, or the database in use. On a Raspberry Pi and Debian it is the wrolpi-rsyncd unit; in Docker the Controller runs it in a helper container made from the api container (its image, user and volumes), so the media directory is still configured in one place. All three read controller/rsyncd.conf. - POST /api/sync/snapshot asks for a snapshot of the database, which the daemon serves from config/.sync. An unchanged database is not written again. - /api/sync/info also says the database's migration and whether the media directory is mounted. Nothing uses these yet; the existing sync is unchanged. Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com> * The rsync daemon follows no links, and no snapshot is made in WROL Mode - A client that asked the daemon to follow symbolic links could read what a link in the library points at. A relative link to config/ssl was read this way although that directory is left out of the module. The daemon now refuses the three options that follow links; a link is sent as a link. - A database snapshot is a new file on the primary's drive, so WROL Mode refuses it, as it does a backup. A snapshot made earlier is still served. Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com> * No rsync helper from an image without rsync, and the helper follows the api container Review found: - A helper made from an api image built before rsync was added exits at once, and Docker restarted it forever while the Controller reported it created. The image is now looked at first; no helper is made from one without rsync, an older helper is left serving, and the reason is logged once. - The helper was only checked when the Controller started, so a recreated or rebuilt api container left it stale. It is now checked every minute. - A snapshot cut off by its process being killed stayed marked as running and held back every later request. - The snapshot's half-written temporary file was served by the daemon. - The comment on the daemon's refused options claimed more than they give: a link that is part of the requested path is still followed. Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com> --------- Co-authored-by: Claude Fable 5.2 <noreply@anthropic.com>
220 lines
8.8 KiB
Bash
Executable file
220 lines
8.8 KiB
Bash
Executable file
#!/usr/bin/env bash
|
|
# This script will attempt to repair a WROLPi installation. It will not use internet.
|
|
|
|
cd /opt/wrolpi || (echo "Cannot repair. /opt/wrolpi does not exist" && exit 1)
|
|
|
|
# Re-execute this script if it wasn't called with sudo.
|
|
if [ $EUID != 0 ]; then
|
|
sudo "$0" "$@"
|
|
exit $?
|
|
fi
|
|
|
|
rpi=false
|
|
if (grep 'Raspberry Pi' /proc/cpuinfo >/dev/null); then
|
|
rpi=true
|
|
fi
|
|
|
|
set -e
|
|
set -x
|
|
|
|
# Stop services if they are running.
|
|
systemctl stop wrolpi-controller.service || :
|
|
systemctl stop wrolpi-api.service || :
|
|
systemctl stop wrolpi-app.service || :
|
|
systemctl stop wrolpi-kiwix.service || :
|
|
systemctl stop caddy || :
|
|
|
|
# Clear Python bytecode cache from virtual environments to fix potential corruption.
|
|
echo "Clearing Python bytecode cache..."
|
|
find /opt/wrolpi/venv -type d -name __pycache__ -exec rm -rf {} + 2>/dev/null || :
|
|
find /opt/wrolpi/venv -name "*.pyc" -delete 2>/dev/null || :
|
|
find /opt/wrolpi/controller/venv -type d -name __pycache__ -exec rm -rf {} + 2>/dev/null || :
|
|
find /opt/wrolpi/controller/venv -name "*.pyc" -delete 2>/dev/null || :
|
|
find /opt/wrolpi-help/venv -type d -name __pycache__ -exec rm -rf {} + 2>/dev/null || :
|
|
find /opt/wrolpi-help/venv -name "*.pyc" -delete 2>/dev/null || :
|
|
|
|
# Create the WROLPi user
|
|
grep wrolpi: /etc/passwd || useradd -md /home/wrolpi wrolpi -s "$(command -v bash)"
|
|
|
|
# Reset any inadvertent changes to the WROLPi repo. Restore ownership in case this repair script fails.
|
|
git config --global --add safe.directory /opt/wrolpi
|
|
git reset HEAD --hard
|
|
chown -R wrolpi:wrolpi /opt/wrolpi
|
|
|
|
# Scripts are run by systemd services (e.g. wrolpi-cert-renew.service) which fail with
|
|
# "Permission denied" if the executable bit was lost.
|
|
chmod +x /opt/wrolpi/*.sh /opt/wrolpi/scripts/*.sh
|
|
|
|
# Copy configs to system.
|
|
mkdir -p /etc/caddy
|
|
cp /opt/wrolpi/etc/raspberrypios/Caddyfile /etc/caddy/Caddyfile
|
|
mkdir -p /var/www
|
|
cp /opt/wrolpi/etc/raspberrypios/50x.html /var/www/50x.html
|
|
# The Controller writes the hotspot captive-portal dnsmasq include here when the hotspot starts.
|
|
# Never copy a file into it: the include only exists while the setting is enabled.
|
|
mkdir -p /etc/NetworkManager/dnsmasq-shared.d
|
|
|
|
# Generate certificate for HTTPS.
|
|
/opt/wrolpi/scripts/generate_certificates.sh
|
|
|
|
# Install map fonts from blob (needed for MapLibre map labels).
|
|
MAP_FONTS_BLOB=/opt/wrolpi-blobs/map-fonts.tar.gz
|
|
if [ -f "${MAP_FONTS_BLOB}" ]; then
|
|
mkdir -p /opt/wrolpi/modules/map/static/fonts
|
|
tar -xzf "${MAP_FONTS_BLOB}" -C /opt/wrolpi/modules/map/static/
|
|
fi
|
|
|
|
# Start Caddy quickly so user can access Controller from React UI
|
|
systemctl start caddy || :
|
|
|
|
# WROLPi needs a few privileged commands.
|
|
cp /opt/wrolpi/etc/raspberrypios/90-wrolpi /etc/sudoers.d/90-wrolpi
|
|
chmod 0440 /etc/sudoers.d/90-wrolpi
|
|
# Verify this new file is valid.
|
|
visudo -c -f /etc/sudoers.d/90-wrolpi
|
|
|
|
# Update the Portable bootstrap on boxes installed from the Live USB; it is
|
|
# otherwise frozen at image-build time.
|
|
LIVE_INCLUDES=/opt/wrolpi/debian-live-config/config/includes.chroot
|
|
if [ -f /usr/local/sbin/wrolpi-bootstrap.sh ]; then
|
|
cp "${LIVE_INCLUDES}/usr/local/sbin/wrolpi-bootstrap.sh" /usr/local/sbin/wrolpi-bootstrap.sh
|
|
chmod 0755 /usr/local/sbin/wrolpi-bootstrap.sh
|
|
if [ -f /etc/systemd/system/wrolpi-bootstrap.service ]; then
|
|
cp "${LIVE_INCLUDES}/etc/systemd/system/wrolpi-bootstrap.service" /etc/systemd/system/wrolpi-bootstrap.service
|
|
fi
|
|
fi
|
|
|
|
# Install the systemd services
|
|
cp /opt/wrolpi/etc/raspberrypios/wrolpi*.service /etc/systemd/system/
|
|
cp /opt/wrolpi/etc/raspberrypios/wrolpi-*.timer /etc/systemd/system/
|
|
cp /opt/wrolpi/etc/raspberrypios/wrolpi.target /etc/systemd/system/
|
|
systemctl enable wrolpi-controller.service
|
|
systemctl enable wrolpi-api.service
|
|
systemctl enable wrolpi-app.service
|
|
systemctl enable wrolpi-kiwix.service
|
|
systemctl enable wrolpi-help.service
|
|
systemctl enable wrolpi-mounts.service
|
|
systemctl enable wrolpi-rsyncd.service
|
|
systemctl enable wrolpi-cert-renew.timer
|
|
|
|
# Repair Controller (offline-safe - no pip install)
|
|
repair_controller() {
|
|
echo "Checking WROLPi Controller..."
|
|
|
|
# Check venv exists
|
|
if [ ! -f /opt/wrolpi/controller/venv/bin/python ]; then
|
|
echo "ERROR: Controller venv missing!"
|
|
echo "Run install.sh or upgrade.sh (requires internet) to reinstall."
|
|
return 1
|
|
fi
|
|
|
|
# Check venv is functional
|
|
if ! /opt/wrolpi/controller/venv/bin/python --version > /dev/null 2>&1; then
|
|
echo "ERROR: Controller venv is corrupted!"
|
|
echo "Run install.sh or upgrade.sh (requires internet) to reinstall."
|
|
return 1
|
|
fi
|
|
|
|
# Check systemd service is installed
|
|
if [ ! -f /etc/systemd/system/wrolpi-controller.service ]; then
|
|
echo "Controller systemd service not installed, copying..."
|
|
cp /opt/wrolpi/etc/raspberrypios/wrolpi-controller.service /etc/systemd/system/
|
|
systemctl daemon-reload
|
|
fi
|
|
|
|
# Ensure service is enabled
|
|
if ! systemctl is-enabled wrolpi-controller > /dev/null 2>&1; then
|
|
echo "Enabling Controller service..."
|
|
systemctl enable wrolpi-controller
|
|
fi
|
|
|
|
echo "Controller repair completed"
|
|
}
|
|
|
|
# Run Controller repair if venv exists (skip on fresh install)
|
|
if [ -d /opt/wrolpi/controller/venv ]; then
|
|
repair_controller || echo "Controller repair failed, continuing..."
|
|
fi
|
|
|
|
# Start Controller so user can monitor repair in UI.
|
|
systemctl start wrolpi-controller
|
|
|
|
/usr/bin/systemctl daemon-reload
|
|
|
|
# WROLPi needs a few privileged commands.
|
|
cp /opt/wrolpi/etc/raspberrypios/90-wrolpi /etc/sudoers.d/90-wrolpi
|
|
chmod 0440 /etc/sudoers.d/90-wrolpi
|
|
# Verify this new file is valid.
|
|
visudo -c -f /etc/sudoers.d/90-wrolpi
|
|
|
|
# WROLPi uses SQLite inside the media directory; the API creates/migrates the database at
|
|
# startup. Never fatal: the media drive may not be mounted yet.
|
|
(cd /opt/wrolpi && /opt/wrolpi/venv/bin/python3 /opt/wrolpi/main.py db upgrade) || \
|
|
echo "WARNING: db upgrade failed (media directory unavailable?); the API will retry at startup."
|
|
|
|
# Create the media directory. This should be mounted by the maintainer.
|
|
[ -d /media/wrolpi ] || mkdir /media/wrolpi
|
|
# Create config directory if external drive is mounted, and is empty.
|
|
if grep -qs /media/wrolpi /proc/mounts && [ -z "$(ls -A /media/wrolpi)" ] && [ ! -d /media/wrolpi/config ]; then
|
|
mkdir /media/wrolpi/config
|
|
fi
|
|
|
|
# Build the frontend app -- only if build/ is missing or the app source changed.
|
|
# The shipped image already contains a current build/, so on a healthy install
|
|
# (including a weak Pi) this is a no-op; it only rebuilds after an upgrade that
|
|
# changed app/, or if build/ went missing. Stays offline: it never npm-installs.
|
|
/opt/wrolpi/scripts/build_app.sh
|
|
|
|
# Change owner of the media directory, ignore any errors because the drive may be fat/exfat/etc.
|
|
chown wrolpi:wrolpi /media/wrolpi 2>/dev/null || echo "Ignoring failure to change media directory permissions."
|
|
# Ensure the config directory is owned by wrolpi so the API can write config files and the SQLite DB.
|
|
[ -d /media/wrolpi/config ] && chown -R wrolpi:wrolpi /media/wrolpi/config 2>/dev/null || :
|
|
|
|
# Remove immutable flag from blob files before chown (may not exist or may not be set).
|
|
chattr -i /opt/wrolpi-blobs/* 2>/dev/null || :
|
|
|
|
# Ship committed blobs (e.g. the default Zim served by Kiwix when the media dir
|
|
# has no working zims) into /opt/wrolpi-blobs. repair.sh runs on every install
|
|
# and upgrade, so this keeps the blobs current there just like the image builds
|
|
# do. It runs after the immutable flag is cleared above (so existing blobs can
|
|
# be overwritten) and before immutability is re-applied below.
|
|
mkdir -p /opt/wrolpi-blobs
|
|
if [ -d /opt/wrolpi/wrolpi/blobs ] && ls /opt/wrolpi/wrolpi/blobs/* >/dev/null 2>&1; then
|
|
cp /opt/wrolpi/wrolpi/blobs/* /opt/wrolpi-blobs/
|
|
fi
|
|
|
|
chown -R wrolpi:wrolpi /home/wrolpi /opt/wrolpi*
|
|
|
|
# Protect blob files from accidental modification or deletion.
|
|
# These files are critical for initializing WROLPi.
|
|
if [ -d /opt/wrolpi-blobs ] && ls /opt/wrolpi-blobs/* >/dev/null 2>&1; then
|
|
chown -R root:root /opt/wrolpi-blobs
|
|
chmod 444 /opt/wrolpi-blobs/*
|
|
chattr +i /opt/wrolpi-blobs/*
|
|
fi
|
|
|
|
# Copy MOTD once the repair has been successful.
|
|
cp /opt/wrolpi/etc/raspberrypios/motd/30-wrolpi.motd /etc/update-motd.d/30-wrolpi
|
|
chmod +x /etc/update-motd.d/*
|
|
|
|
# Copy desktop shortcuts to existing users (new users get them from /etc/skel).
|
|
if [[ ${rpi} == true ]]; then
|
|
for user_home in /home/wrolpi /home/pi; do
|
|
if [ -d "${user_home}/Desktop" ]; then
|
|
cp /opt/wrolpi/etc/raspberrypios/*.desktop "${user_home}/Desktop/"
|
|
chown -R "$(basename ${user_home})":"$(basename ${user_home})" "${user_home}/Desktop/"
|
|
fi
|
|
done
|
|
# Update skeleton for future users.
|
|
mkdir -p /etc/skel/Desktop
|
|
cp /opt/wrolpi/etc/raspberrypios/*.desktop /etc/skel/Desktop/
|
|
fi
|
|
|
|
systemctl restart wrolpi-help
|
|
# Restarted, not only started: its config may have changed.
|
|
systemctl restart wrolpi-rsyncd || :
|
|
systemctl start wrolpi.target
|
|
|
|
set +x
|
|
|
|
echo "Repair has completed. You may run /opt/wrolpi/help.sh to check system status."
|