mirror of
https://github.com/lrnselfreliance/wrolpi.git
synced 2026-10-26 10:51:36 -04:00
19f4958fb5
Two related gaps in how WROLPi serves Kiwix content: 1. A fresh WROLPi (or one whose zims are all corrupt/absent) showed a blank Kiwix. Every image now ships a small built-in default Zim that Kiwix falls back to, telling the user to download real Zim files. 2. The startup scripts hardcoded the `/zims` directory, ignoring wrolpi.yaml's `zims_destination` (which the Python side already honors). Changes: - New wrolpi/scripts/read_config_value.sh: a zero-dependency (awk) reader so non-Python scripts can reliably read top-level wrolpi.yaml scalars. Also a config_value() wrapper in wrolpi/scripts/lib.sh. - New wrolpi/scripts/default_zim/: HTML source + a reproducible builder (ghcr.io/openzim/zim-tools) that outputs the committed wrolpi/blobs/default.zim. - New wrolpi/blobs/: any committed blob here is copied to /opt/wrolpi-blobs by the pi-gen and debian-live builds; the Docker zim image bakes it in. - start_kiwix_serve.sh honors zims_destination and falls back to the default Zim when no functioning zim is found. - docker/zim/entrypoint.sh gains the same default-Zim fallback. It needs no config read: it already scans the whole mounted media dir, and zims_destination is always a subdirectory of that mount. - Changing zims_destination via the settings API now restarts Kiwix so it serves the new directory without a reboot. Tests: new test_read_config_value.py, extended test_start_kiwix_serve.py (configured dir + default-Zim fallback), and a root_api test for the restart. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
38 lines
1.6 KiB
Bash
Executable file
38 lines
1.6 KiB
Bash
Executable file
#! /usr/bin/env bash
|
|
set -u
|
|
|
|
LIBRARY=/library.xml
|
|
# Default Zim baked into the image; served when no real zim is available.
|
|
DEFAULT_ZIM="${DEFAULT_ZIM:-/opt/wrolpi-blobs/default.zim}"
|
|
|
|
rm -f "${LIBRARY}"
|
|
|
|
# Import every *.zim under the mounted media directory. A corrupt or partial
|
|
# zim is rejected by kiwix-manage; skip it so the remaining valid zims are
|
|
# still served. We scan the whole media mount, so any configured
|
|
# `zims_destination` subdirectory is covered automatically -- no config read.
|
|
added_zim=false
|
|
while IFS= read -r -d '' zim; do
|
|
if /import_zim.sh "${zim}"; then
|
|
added_zim=true
|
|
else
|
|
echo "Skipping zim which could not be added (corrupt or incomplete?): ${zim}" >&2
|
|
fi
|
|
done < <(find /media/wrolpi -iname '*.zim' -print0)
|
|
|
|
# When no functioning zim was added, fall back to the default Zim so the user
|
|
# sees a helpful placeholder instead of a blank Kiwix.
|
|
if [ "${added_zim}" = false ] && [ -f "${DEFAULT_ZIM}" ]; then
|
|
echo "No usable Zim files found; serving the default WROLPi Zim: ${DEFAULT_ZIM}" >&2
|
|
/import_zim.sh "${DEFAULT_ZIM}" || echo "Failed to add the default Zim" >&2
|
|
fi
|
|
|
|
# Ensure a library file always exists so kiwix-serve can start regardless.
|
|
if [ ! -f "${LIBRARY}" ]; then
|
|
printf '<?xml version="1.0" encoding="UTF-8"?>\n<library version="20110515">\n</library>\n' > "${LIBRARY}"
|
|
fi
|
|
|
|
# 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").
|
|
kiwix-serve --monitorLibrary --library "${LIBRARY}" --port 80
|