BookStack vs Wiki.js: 200 pages, search and backups

# lab/stacks/bookstack/compose.yml with APP_URL set to the host port the screenshot tunnel uses (BookStack redirects to APP_URL), plus API_REQUESTS_PER_MIN (BookStack's default is 180 requests a minute, which a 200-page loop would hit).
x-lab: {title: "BookStack", version: "26.09.2", ready: "http://127.0.0.1:8080/login", ready_ok: "200", ui: "http://127.0.0.1:8080/login", ready_timeout: 300}
services:
  bookstack:
    image: lscr.io/linuxserver/bookstack:26.09.2
    restart: unless-stopped
    depends_on: [db]
    environment:
      PUID: "1000"
      PGID: "1000"
      APP_URL: http://127.0.0.1:18391
      APP_KEY: "base64:bGFiLW9ubHktbm90LWEtc2VjcmV0LWxhYi1vbmx5ISE="
      DB_HOST: db
      DB_PORT: "3306"
      DB_USERNAME: bookstack
      DB_PASSWORD: lab-only-not-a-secret
      DB_DATABASE: bookstack
      API_REQUESTS_PER_MIN: "100000"
    ports:
      - "127.0.0.1:8080:80"
    volumes:
      - bookstack:/config
  db:
    image: mariadb:11.8
    restart: unless-stopped
    environment:
      MARIADB_ROOT_PASSWORD: lab-only-not-a-secret
      MARIADB_DATABASE: bookstack
      MARIADB_USER: bookstack
      MARIADB_PASSWORD: lab-only-not-a-secret
    volumes:
      - db:/var/lib/mysql
volumes:
  bookstack:
  db:

#!/usr/bin/env bash
# wiki: BookStack 26.09.2 (MariaDB 11.8) vs Wiki.js 2.5.315 (PostgreSQL 16): 200 pages through the API, search timings, RAM, backups.
set -uo pipefail
source "$(dirname "$0")/../_dlib.sh"
T=wiki; OUT="$ROOT/evidence/tests/$T"; RAW="$OUT/raw"; D="$ROOT/lab/tests/$T"
TOOLS=("$@"); [ ${#TOOLS[@]} -eq 0 ] && TOOLS=(bookstack wikijs)
[ $# -eq 0 ] && rm -rf "$OUT"; mkdir -p "$RAW"   # with explicit tool names, only those are re-run
one() {
  local tool="$1"
  start_vm d-$T-$tool
  vm scp-to "$([ $tool = bookstack ] && echo "$D/files/bookstack.yml" || echo "$ROOT/lab/stacks/$tool/compose.yml")" compose.yml >/dev/null
  vm scp-to "$D/wikitest.py" wikitest.py >/dev/null; vm scp-to "$ROOT/lab/tests/_dsample.py" sample.py >/dev/null
  cpull '~' stack
  gx 'docker compose -p stack up -d 2>&1 | tail -1'
  local tok=""
  if [ $tool = bookstack ]; then
    until [ "$(gx 'curl -s -o /dev/null -w %{http_code} http://127.0.0.1:8080/login')" = 200 ]; do sleep 3; done
    sleep 15
    gx "bash -s" < "$D/bs-token.sh" > "$RAW/bookstack-token.txt" 2>&1
    tok="labtokenid0123456789abcdefghijklmno:labsecret0123456789abcdefghijklmnop"
    n=0; until [ "$(gx "curl -s -o /dev/null -w %{http_code} -H 'Authorization: Token $tok' http://127.0.0.1:8080/api/books")" = 200 ]; do n=$((n+1)); [ $n -gt 40 ] && { echo "bookstack API never returned 200" > "$RAW/bookstack-FAILED.txt"; return 1; }; sleep 5; done
  else
    until [ "$(gx 'curl -s -o /dev/null -w %{http_code} http://127.0.0.1:8080/')" != 000 ]; do sleep 3; done
    gx 'curl -s -X POST http://127.0.0.1:8080/finalize -H "content-type: application/json" -d "{\"adminEmail\":\"admin@lab.internal\",\"adminPassword\":\"lab-only-not-a-secret\",\"adminPasswordConfirm\":\"lab-only-not-a-secret\",\"siteUrl\":\"http://127.0.0.1:8080\",\"telemetry\":false}"' > "$RAW/wikijs-finalize.txt" 2>&1
    sleep 25
  fi
  sleep 60
  local names; names=$([ $tool = bookstack ] && echo "stack-bookstack-1 stack-db-1" || echo "stack-wiki-1 stack-db-1")
  gx "python3 sample.py $names" > "$RAW/$tool-ram-before.json"
  gx "python3 wikitest.py $tool $tok" > "$RAW/$tool-api.json" 2> "$RAW/$tool-api.err"
  sleep 30
  gx "python3 sample.py $names" > "$RAW/$tool-ram-after.json"
  # Backups, following each project's documented method
  if [ $tool = bookstack ]; then
    gx 'docker exec stack-db-1 mariadb-dump -u bookstack -plab-only-not-a-secret bookstack > /tmp/bs.sql 2>/dev/null; echo "dump_bytes $(stat -c %s /tmp/bs.sql)"; gzip -k /tmp/bs.sql; echo "dump_gz_bytes $(stat -c %s /tmp/bs.sql.gz)"
     docker exec stack-bookstack-1 sh -c "cd /app/www && tar -czf /tmp/files-docs.tgz .env public/uploads storage/uploads themes 2>&1 | tail -2; echo docs_command_archive_bytes \$(stat -c %s /tmp/files-docs.tgz); tar -czhf /tmp/files-follow.tgz .env public/uploads storage/uploads themes 2>&1 | tail -2; echo follow_symlinks_archive_bytes \$(stat -c %s /tmp/files-follow.tgz); ls -l .env public/uploads themes | head -5"' > "$RAW/bookstack-backup.txt" 2>&1
  else
    gx 'docker exec stack-db-1 pg_dump wiki -U wikijs -F c > /tmp/wiki.dump; echo "dump_c_bytes $(stat -c %s /tmp/wiki.dump)"; echo "sql_gz_bytes $(docker exec stack-db-1 pg_dump wiki -U wikijs | gzip | wc -c)"' > "$RAW/wikijs-backup.txt" 2>&1
  fi
  gx "sudo sh -c \"du -sb /var/lib/docker/volumes/stack_*/_data\"; docker inspect -f '{{.Name}} restarts={{.RestartCount}}' \$(docker ps -aq)" > "$RAW/$tool-disk.txt" 2>&1
  local S="$ROOT/public/shots/$T"
  if [ $tool = bookstack ]; then
    shot 8080 /login "$S/bookstack.png" '[{"fill":"input[name=email]","value":"admin@admin.com"},{"fill":"input[name=password]","value":"password"},{"press":"Enter"},{"wait":4000},{"goto":"http://127.0.0.1:18391/books/book-1"},{"wait":2000}]'
  else
    shot 8080 /login "$S/wikijs.png" '[{"wait":6000},{"fill":"input[autocomplete=username],input[type=email],input[type=text]","value":"admin@lab.internal"},{"fill":"input[type=password]","value":"lab-only-not-a-secret"},{"press":"Enter"},{"wait":5000},{"goto":"http://127.0.0.1:18391/book-1/page-0001"},{"wait":3000}]'
  fi
  mkdir -p "$RAW/$tool-env"; collect_env "$RAW/$tool-env"
}
for t in "${TOOLS[@]}"; do ( one "$t" ); done
python3 "$D/summarize.py" "$RAW" "$OUT"

#!/usr/bin/env python3
"""Runs in the VM. Usage: wikitest.py bookstack <token_id:secret> | wikijs. Creates 10 books/folders x 20 pages = 200 pages through the HTTP API
(about 3 KB of Markdown each), then times 4 search queries x 20 calls. Prints JSON."""
import json, random, statistics as st, sys, time, urllib.parse, urllib.request
tool = sys.argv[1]; B = "http://127.0.0.1:8080"; r = random.Random(11)
words = "alpha bravo charlie delta echo foxtrot golf hotel india juliet kilo lima mike november oscar papa quebec romeo sierra tango uniform victor whiskey xray yankee zulu".split()
def page(i):
    body = "\n\n".join("## Section %d\n\n%s." % (s, " ".join(r.choice(words) for _ in range(60))) for s in range(8))
    return f"Page {i:04d}", f"Marker zq{i:04d}marker.\n\n" + body
def http(method, path, body=None, headers=None):
    h = {"content-type": "application/json", **(headers or {})}
    t = time.perf_counter()
    resp = urllib.request.urlopen(urllib.request.Request(B + path, data=json.dumps(body).encode() if body is not None else None, headers=h, method=method), timeout=120)
    d = resp.read(); return time.perf_counter() - t, json.loads(d) if d else None
out = {"tool": tool, "pages": 200}
create = []
if tool == "bookstack":
    H = {"Authorization": "Token " + sys.argv[2]}; ids = []
    for b in range(1, 11):
        _, d = http("POST", "/api/books", {"name": f"Book {b}"}, H); ids.append(d["id"])
    t_all = time.perf_counter()
    for i in range(200):
        title, md = page(i); t, d = http("POST", "/api/pages", {"book_id": ids[i // 20], "name": title, "markdown": md}, H); create.append(t * 1000)
    total = time.perf_counter() - t_all
    search = lambda q: http("GET", "/api/search?query=%s&count=20" % q, None, H)
else:
    H = {}
    _, d = http("POST", "/graphql", {"query": 'mutation { authentication { login(username: "admin@lab.internal", password: "lab-only-not-a-secret", strategy: "local") { jwt responseResult { succeeded message } } } }'})
    H = {"Authorization": "Bearer " + d["data"]["authentication"]["login"]["jwt"]}
    t_all = time.perf_counter(); fails = 0
    for i in range(200):
        title, md = page(i)
        q = 'mutation($c: String!, $t: String!, $p: String!) { pages { create(content: $c, description: "", editor: "markdown", isPublished: true, isPrivate: false, locale: "en", path: $p, tags: [], title: $t) { responseResult { succeeded message } } } }'
        t, d = http("POST", "/graphql", {"query": q, "variables": {"c": md, "t": title, "p": f"book-{i // 20 + 1}/page-{i:04d}"}}, H); create.append(t * 1000)
        if not d["data"]["pages"]["create"]["responseResult"]["succeeded"]: fails += 1
    total = time.perf_counter() - t_all; out["create_failures"] = fails
    def search(q):
        return http("POST", "/graphql", {"query": 'query($q: String!) { pages { search(query: $q) { totalHits results { id } } } }', "variables": {"q": urllib.parse.unquote(q)}}, H)
out["create_total_s"] = round(total, 2); out["create_ms"] = {"median": round(st.median(create), 1), "min": round(min(create), 1), "max": round(max(create), 1)}
sr = {}
for label, q in (("title, one page (\"Page 0123\")", "Page%200123"), ("title, all pages (\"Page\")", "Page"), ("body-only rare word (zq0123marker)", "zq0123marker"), ("body-only common word (quebec)", "quebec")):
    ts = []; hits = None
    for _ in range(20):
        t, d = search(q); ts.append(t * 1000)
        if hits is None: hits = (d["total"] if tool == "bookstack" else d["data"]["pages"]["search"]["totalHits"])
    sr[label] = {"median_ms": round(st.median(ts), 1), "min_ms": round(min(ts), 1), "max_ms": round(max(ts), 1), "hits": hits}
out["search"] = sr
if tool == "bookstack":
    out["rate_limit_header"] = urllib.request.urlopen(urllib.request.Request(B + "/api/books?count=1", headers=H)).headers.get("X-RateLimit-Limit")
print(json.dumps(out, indent=1))

#!/usr/bin/env bash
# Runs in the VM: inserts an API token for the default BookStack admin (user 1) directly into MariaDB.
# BookStack stores the secret as a bcrypt hash, so one is generated with the app's own PHP.
SEC=labsecret0123456789abcdefghijklmnop
HASH=$(docker exec stack-bookstack-1 php -r 'echo password_hash($argv[1], PASSWORD_BCRYPT);' "$SEC")
docker exec stack-db-1 mariadb -u bookstack -plab-only-not-a-secret bookstack -e "INSERT INTO api_tokens (name, token_id, secret, user_id, expires_at, created_at, updated_at) VALUES ('bench','labtokenid0123456789abcdefghijklmno','$HASH',1,'2099-01-01',NOW(),NOW());"
echo "inserted, hash prefix: ${HASH:0:4}"