Skip to content

Add read-only health check script / Salt okunur sağlık kontrolü betiği #12

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
schematrix merged 1 commit into from
Nov 6, 2026
Merged

Add read-only health check script / Salt okunur sağlık kontrolü betiği #12

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,13 +79,20 @@ install.sh main installer
scripts/setup-ssd.sh mounts the SSD at /library
scripts/download-content.sh downloads/updates ZIM files from Kiwix
scripts/install-homepage.sh installs the custom homepage
scripts/status.sh health check: disk, services, hotspot, content, power
config/iiab-overrides.yml Internet-in-a-Box settings
config/content.conf list of content to download
www/home/index.html homepage
```

### Troubleshooting

Start with the health check. It only reads, needs no sudo, and points to the matching fix below:
```bash
./scripts/status.sh
```
It checks free space on the SD card and SSD, the web, Kiwix, hotspot and DHCP services, the hotspot bridge, which ZIMs from `config/content.conf` are missing or not yet in the Kiwix library, unfinished downloads, CPU temperature and under-voltage. It exits with 1 if it finds a problem, so it can also run from cron.

- **`ssh user@hostname.local` stops working after install.** Internet-in-a-Box renames the Pi to `box`. Use `ssh user@box.local` or the Pi's IP address. To find the IP, run `arp -a` on your computer or check your router's device list.
- **Chromium says the profile is locked.** This also comes from the hostname change. Click "Unlock Profile", or run `rm -f ~/.config/chromium/Singleton*`.
- **The hotspot doesn't appear.** Connect over Ethernet, check `sudo iiab-diagnostics`, and make sure the install finished: `/etc/iiab/install-flags/iiab-complete` must exist.
Expand Down Expand Up @@ -193,13 +200,20 @@ install.sh ana kurulum betiği
scripts/setup-ssd.sh SSD'yi /library klasörüne bağlar
scripts/download-content.sh Kiwix'ten ZIM dosyalarını indirir/günceller
scripts/install-homepage.sh özel ana sayfayı kurar
scripts/status.sh sağlık kontrolü: disk, servisler, hotspot, içerik, güç
config/iiab-overrides.yml Internet-in-a-Box ayarları
config/content.conf indirilecek içerik listesi
www/home/index.html ana sayfa
```

### Sorun giderme

Önce sağlık kontrolünü çalıştır. Sadece okur, sudo gerektirmez ve aşağıdaki ilgili çözüme yönlendirir:
```bash
./scripts/status.sh
```
SD kart ve SSD'deki boş alanı, web, Kiwix, hotspot ve DHCP servislerini, hotspot köprüsünü, `config/content.conf` içindeki ZIM'lerden eksik olanları ya da Kiwix kütüphanesine henüz eklenmemiş olanları, yarım kalan indirmeleri, işlemci sıcaklığını ve düşük voltajı kontrol eder. Sorun bulursa 1 koduyla çıkar, bu yüzden cron ile de çalıştırılabilir.

- **Kurulumdan sonra `ssh kullanici@hostname.local` çalışmıyor.** Internet-in-a-Box cihazın adını `box` yapar. `ssh kullanici@box.local` ya da Pi'nin IP adresini kullan. IP adresini bulmak için bilgisayarında `arp -a` çalıştır ya da modeminin cihaz listesine bak.
- **Chromium "profile is locked" hatası veriyor.** Bu da cihaz adının değişmesinden kaynaklanır. "Unlock Profile" butonuna tıkla ya da `rm -f ~/.config/chromium/Singleton*` komutunu çalıştır.
- **Hotspot görünmüyor.** Ethernet ile bağlan, `sudo iiab-diagnostics` komutuyla kontrol et ve kurulumun bittiğinden emin ol: `/etc/iiab/install-flags/iiab-complete` dosyası var olmalı.
Expand Down
175 changes: 175 additions & 0 deletions scripts/status.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,175 @@
#!/usr/bin/env bash
# HAS_PrepperDisk sağlık kontrolü: disk, servisler, hotspot, içerikler, güç ve sıcaklık.
# Health check: disk, services, hotspot, content, power and temperature.
# Sadece okur, hiçbir şeyi değiştirmez. sudo gerekmez.
# Read-only, changes nothing. No sudo needed.
#
# Kullanım / usage: ./scripts/status.sh [config-dosyası]
# Çıkış kodu / exit code: 0 = sorun yok / all good, 1 = en az bir sorun / at least one problem
set -uo pipefail
shopt -s nullglob

CONF="${1:-$(cd "$(dirname "$0")/.." && pwd)/config/content.conf}"
ZIMS=/library/zims/content
LIBXML=/library/zims/library.xml
problems=0

say(){ printf '\n\033[1m== %s\033[0m\n' "$*"; }
ok(){ printf ' OK %s\n' "$*"; }
info(){ printf ' -- %s\n' "$*"; }
bad(){ printf ' !! %s\n' "$*"; problems=$((problems+1)); }
has(){ command -v "$1" >/dev/null 2>&1; }

# ---------------------------------------------------------------- disk
say "Disk"
mps=(/)
if mountpoint -q /library 2>/dev/null; then
ok "/library ayrı diskte / is on its own disk ($(findmnt -no SOURCE /library))"
mps+=(/library)
else
bad "/library ayrı bir disk değil, içerikler SD karta yazılır / is not a separate disk, content goes to the SD card"
fi
for mp in "${mps[@]}"; do
read -r size used avail pct < <(df -h --output=size,used,avail,pcent "$mp" | tail -1)
msg="$mp: $used / $size dolu / used, $avail boş / free ($pct)"
if [ "${pct%\%}" -ge 90 ]; then bad "$msg"; else ok "$msg"; fi
done

# ---------------------------------------------------------------- servisler
say "Servisler / services"
if has systemctl; then
for svc in nginx kiwix-serve hostapd dnsmasq kolibri; do
if ! systemctl list-unit-files "$svc.service" --no-legend 2>/dev/null | grep -q .; then
info "$svc kurulu değil / not installed"
continue
fi
state=$(systemctl is-active "$svc" 2>/dev/null)
if [ "$state" = active ]; then ok "$svc"
else bad "$svc: $state (kayıt / log: sudo journalctl -u $svc -n 50)"; fi
done
else
info "systemctl yok / not found"
fi

# ---------------------------------------------------------------- hotspot
say "Hotspot"
if has iw; then
ap=$(iw dev 2>/dev/null | awk '$1=="Interface"{i=$2} $1=="type" && $2=="AP"{print i; exit}')
if [ -n "$ap" ]; then
ssid=$(iw dev "$ap" info 2>/dev/null | awk '$1=="ssid"{$1=""; sub(/^ /,""); print; exit}')
if stations=$(iw dev "$ap" station dump 2>/dev/null); then
clients=$(grep -c '^Station' <<<"$stations")
else
clients="?"
fi
ok "$ap yayında / broadcasting: \"$ssid\", bağlı cihaz / clients: $clients"
else
bad "hiçbir arayüz hotspot modunda değil / no interface in AP mode (README: Sorun giderme / Troubleshooting)"
fi
else
info "iw yok / not found"
fi
if has ip && ip link show br0 >/dev/null 2>&1; then
br=$(ip -br link show br0 | awk '{print $2}')
if [ "$br" = UP ]; then ok "br0 $br"
else bad "br0 $br: hotspot köprüsü kapalı / hotspot bridge is down (README: Sorun giderme / Troubleshooting)"; fi
fi

# ---------------------------------------------------------------- web
say "Web"
if has curl; then
for url in http://localhost/home/ http://localhost/kiwix/; do
code=$(curl -s -o /dev/null -m 5 -w '%{http_code}' "$url")
case "$code" in
2*|3*) ok "$url ($code)";;
*) bad "$url yanıt vermiyor / not responding ($code)";;
esac
done
else
info "curl yok / not found"
fi

# ---------------------------------------------------------------- içerik
say "İçerik / content"
if [ ! -f "$CONF" ]; then
bad "$CONF bulunamadı / not found"
elif [ ! -d "$ZIMS" ]; then
bad "$ZIMS yok. İçerik indir / download content: sudo ./scripts/download-content.sh"
else
present=0; missing=()
while read -r folder prefix _; do
case "$folder" in ''|\#*) continue;; esac
found=("$ZIMS/${prefix}"_[0-9][0-9][0-9][0-9]-[0-9][0-9]*.zim)
if [ ${#found[@]} -gt 0 ]; then present=$((present+1)); else missing+=("$prefix"); fi
done < "$CONF"

info "$(du -sh "$ZIMS" 2>/dev/null | cut -f1) $ZIMS"
if [ ${#missing[@]} -eq 0 ]; then
ok "content.conf: $present/$present ZIM var / present"
else
bad "content.conf: $present/$((present+${#missing[@]})) ZIM var / present. Eksik / missing:"
printf ' %s\n' "${missing[@]}"
info "indirmek için / to download: sudo ./scripts/download-content.sh"
fi

parts=("$ZIMS"/*.part)
if [ ${#parts[@]} -gt 0 ]; then
bad "${#parts[@]} yarım indirme / unfinished download(s). Devam için / to resume: sudo ./scripts/download-content.sh"
fi

# Diskte olup Kiwix kütüphanesinde olmayan ZIM'ler ana sayfada görünmez.
# ZIMs on disk but missing from the Kiwix library do not show up on the homepage.
if [ -f "$LIBXML" ]; then
unlisted=()
for z in "$ZIMS"/*.zim; do
grep -qF "${z##*/}" "$LIBXML" || unlisted+=("${z##*/}")
done
if [ ${#unlisted[@]} -eq 0 ]; then
ok "tüm ZIM'ler Kiwix kütüphanesinde / all ZIMs are in the Kiwix library"
else
bad "${#unlisted[@]} ZIM Kiwix kütüphanesinde değil / not in the Kiwix library:"
printf ' %s\n' "${unlisted[@]}"
info "düzeltmek için / to fix: sudo iiab-make-kiwix-lib"
fi
else
bad "$LIBXML yok / not found. Çalıştır / run: sudo iiab-make-kiwix-lib"
fi
fi

# ---------------------------------------------------------------- güç ve sıcaklık
say "Güç ve sıcaklık / power and temperature"
has vcgencmd || [ -r /sys/class/thermal/thermal_zone0/temp ] || info "okunamadı (Raspberry Pi değil mi?) / not available (not a Raspberry Pi?)"
if [ -r /sys/class/thermal/thermal_zone0/temp ]; then
c=$(( $(cat /sys/class/thermal/thermal_zone0/temp) / 1000 ))
if [ "$c" -ge 80 ]; then bad "CPU ${c}°C: çok sıcak, soğutucuyu kontrol et / too hot, check the cooler"
else ok "CPU ${c}°C"; fi
fi
if has vcgencmd; then
if t=$(vcgencmd get_throttled 2>/dev/null) && [ -n "${t#*=}" ]; then
v=$(( ${t#*=} ))
if [ "$v" -eq 0 ]; then
ok "düşük voltaj ya da yavaşlama yok / no under-voltage or throttling ($t)"
else
(( v & 0x1 )) && bad "ŞU AN düşük voltaj / under-voltage NOW: 5V/5A adaptör kullan / use a 5V/5A supply"
(( v & 0x10000 )) && bad "açılıştan beri düşük voltaj oldu / under-voltage occurred since boot"
(( v & 0x4 )) && bad "şu an yavaşlatılıyor / currently throttled"
(( v & 0x8 )) && bad "şu an sıcaklık sınırında / soft temperature limit active"
(( v & 0xE0000 )) && bad "açılıştan beri yavaşlama ya da sıcaklık sınırı oldu / throttling or temperature limit occurred since boot"
info "$t"
fi
else
info "vcgencmd okunamadı / could not read vcgencmd (video grubunda mısın? / are you in the video group?)"
fi
if volt=$(vcgencmd pmic_read_adc EXT5V_V 2>/dev/null) && [[ $volt == *=*V ]]; then
info "giriş voltajı / input voltage: ${volt#*=}"
fi
fi

# ---------------------------------------------------------------- sonuç
say "Sonuç / result"
if [ "$problems" -eq 0 ]; then
echo "Her şey yolunda / all good"
exit 0
fi
echo "$problems sorun bulundu / problem(s) found"
exit 1