mirror of
https://github.com/lrnselfreliance/wrolpi.git
synced 2026-10-26 19:01:39 -04:00
cdcf771ffa
A corrupt or partial *.zim (e.g. an interrupted download) is rejected by
kiwix-manage ("Cannot add zim ..."). start_kiwix_serve.sh could then leave
Kiwix down and reported a misleading "Could not find any Zim files" — and
if the bad zim was the only one, exit 2 killed the service with no restart.
- Import each zim independently; log and skip a failed add so the remaining
valid zims are still served.
- Always ensure a library.xml exists (empty if needed) and exec kiwix-serve
unconditionally, so a corrupt/absent zim never stops the server starting.
- Fix the mount-wait loop, which never incremented COUNT (infinite wait
instead of a 30s timeout).
- Add MEDIA_DIRECTORY override so the script is testable.
- Add Restart=on-failure to wrolpi-kiwix.service (matches wrolpi-api.service)
so transient failures self-heal.
- New test harness runs the script with fake kiwix-manage/kiwix-serve shims.
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
60 lines
2.2 KiB
Bash
Executable file
60 lines
2.2 KiB
Bash
Executable file
#! /usr/bin/env bash
|
|
# This file imports all *.zim files in the Zim media directory, then starts kiwix-serve.
|
|
set -u
|
|
|
|
# The media directory is overridable for testing; defaults to the production mount.
|
|
MEDIA_DIRECTORY="${MEDIA_DIRECTORY:-/media/wrolpi}"
|
|
|
|
[ ! -d "${MEDIA_DIRECTORY}" ] && echo "Cannot start kiwix without media directory mounted" && exit 1
|
|
|
|
ZIM_DIRECTORY="${MEDIA_DIRECTORY}/zims"
|
|
LIBRARY="${ZIM_DIRECTORY}/library.xml"
|
|
|
|
# Wait up to 30 seconds for the zims directory to be mounted.
|
|
COUNT=0
|
|
while [ ${COUNT} -lt 30 ]; do
|
|
if [ -d "${ZIM_DIRECTORY}" ]; then
|
|
break
|
|
fi
|
|
COUNT=$((COUNT + 1))
|
|
sleep 1
|
|
done
|
|
|
|
# Create the zim directory, if necessary.
|
|
[ ! -d "${ZIM_DIRECTORY}" ] && mkdir -p "${ZIM_DIRECTORY}"
|
|
|
|
# We will replace the library file.
|
|
rm -f "${LIBRARY}"
|
|
|
|
# Import every *.zim. A corrupt or partial zim is rejected by kiwix-manage
|
|
# ("Cannot add zim ..."); it must NOT prevent the remaining valid zims from
|
|
# being served, nor stop the server from starting. So we add each zim
|
|
# independently and never abort on a single failure.
|
|
found_zim=false
|
|
added_zim=false
|
|
while IFS= read -r -d '' zim; do
|
|
found_zim=true
|
|
if kiwix-manage "${LIBRARY}" add "${zim}"; then
|
|
added_zim=true
|
|
else
|
|
echo "Skipping zim which could not be added (corrupt or incomplete?): ${zim}" >&2
|
|
fi
|
|
done < <(find "${ZIM_DIRECTORY}" -iname '*.zim' -print0)
|
|
|
|
if [ "${found_zim}" = false ]; then
|
|
echo "Could not find any Zim files to import"
|
|
elif [ "${added_zim}" = false ]; then
|
|
echo "Found Zim files but none could be added (all corrupt or incomplete?); starting Kiwix with an empty library" >&2
|
|
fi
|
|
|
|
# Ensure a library file always exists so kiwix-serve can start even when there
|
|
# are no valid zims. A single corrupt zim must never take down the server.
|
|
if [ ! -f "${LIBRARY}" ]; then
|
|
printf '<?xml version="1.0" encoding="UTF-8"?>\n<library version="20110515">\n</library>\n' > "${LIBRARY}"
|
|
fi
|
|
|
|
# Serve HTTP kiwix on 9085. Caddy will serve HTTPS on 8085.
|
|
# Bind all interfaces by omitting --address: kiwix-serve defaults to all
|
|
# interfaces, and trixie's kiwix-tools 3.7.0 rejects the literal
|
|
# "--address 0.0.0.0" ("IP address is not available on this system").
|
|
exec kiwix-serve --library "${LIBRARY}" --port 9085
|