mirror of
https://github.com/lrnselfreliance/wrolpi.git
synced 2026-11-20 06:56:18 -05:00
zim: ship a default fallback Zim and honor the configured Zim directory
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>
This commit is contained in:
parent
ddb8b4b590
commit
19f4958fb5
15 changed files with 362 additions and 14 deletions
|
|
@ -2,12 +2,19 @@
|
|||
# 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.
|
||||
# The media directory and project directory are overridable for testing;
|
||||
# they default to the production locations.
|
||||
MEDIA_DIRECTORY="${MEDIA_DIRECTORY:-/media/wrolpi}"
|
||||
PROJECT_DIR="${PROJECT_DIR:-/opt/wrolpi}"
|
||||
# Default Zim shipped in /opt/wrolpi-blobs; served when no real zim is available.
|
||||
DEFAULT_ZIM="${DEFAULT_ZIM:-/opt/wrolpi-blobs/default.zim}"
|
||||
|
||||
[ ! -d "${MEDIA_DIRECTORY}" ] && echo "Cannot start kiwix without media directory mounted" && exit 1
|
||||
|
||||
ZIM_DIRECTORY="${MEDIA_DIRECTORY}/zims"
|
||||
# Honor the configured Zim directory (wrolpi.yaml `zims_destination`, always
|
||||
# relative to the media directory), defaulting to `zims`.
|
||||
ZIMS_DEST="$(MEDIA_DIRECTORY="${MEDIA_DIRECTORY}" "${PROJECT_DIR}/wrolpi/scripts/read_config_value.sh" zims_destination zims)"
|
||||
ZIM_DIRECTORY="${MEDIA_DIRECTORY}/${ZIMS_DEST}"
|
||||
LIBRARY="${ZIM_DIRECTORY}/library.xml"
|
||||
|
||||
# Wait up to 30 seconds for the zims directory to be mounted.
|
||||
|
|
@ -44,11 +51,20 @@ 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
|
||||
echo "Found Zim files but none could be added (all corrupt or incomplete?)" >&2
|
||||
fi
|
||||
|
||||
# When no functioning zim was added, fall back to the default Zim shipped in
|
||||
# /opt/wrolpi-blobs so the user sees a helpful placeholder ("download some Zim
|
||||
# files") instead of a blank Kiwix. A single corrupt zim must never take down
|
||||
# the server.
|
||||
if [ "${added_zim}" = false ] && [ -f "${DEFAULT_ZIM}" ]; then
|
||||
echo "No usable Zim files found; serving the default WROLPi Zim: ${DEFAULT_ZIM}" >&2
|
||||
kiwix-manage "${LIBRARY}" add "${DEFAULT_ZIM}" || echo "Failed to add the default Zim" >&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.
|
||||
# are no valid zims and the default Zim is missing.
|
||||
if [ ! -f "${LIBRARY}" ]; then
|
||||
printf '<?xml version="1.0" encoding="UTF-8"?>\n<library version="20110515">\n</library>\n' > "${LIBRARY}"
|
||||
fi
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue