mirror of
https://github.com/Crosstalk-Solutions/project-nomad.git
synced 2026-07-28 03:04:41 +02:00
d07b08df6e
* feat(creator-packs): backend rail for gated creator content packs
Phase 1 of Creator Packs: the app-side download rail for per-creator
video ZIMs served from the private R2 bucket behind the entitlement
Worker. No UI yet (Phase 2).
- Thread optional requestHeaders through the download util + job so the
ZIM fetch can carry `Authorization: Bearer <APP_KEY>` on both the HEAD
probe and the GET stream (Worker streams the ZIM directly, gated).
- Add resourceMetadata.skip_embedding and gate the RAG/EmbedFileJob
branch on it so video ZIMs are never sent to the knowledge base.
- New creator_packs ManifestType + creatorPacksSpecSchema (display
metadata only, no url) + CollectionManifestService wiring and
getCreatorPacksWithStatus() status join.
- collections/creator-packs.json catalog with the two seed packs.
- CreatorPackService.installPack: ensure Kiwix (auto-install if absent),
resolve the stable Worker URL, dispatch the gated download with
skip_embedding. Typed result codes.
- CreatorPacksController + GET/POST /api/creator-packs routes.
- CREATOR_PACKS_APP_KEY / CREATOR_PACKS_WORKER_BASE env (release-injected
key; app degrades to a clear not_configured error when unset).
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
* feat(creator-packs): Phase 2 UI — Content Explorer, settings page, wizard step
Adds the three user-facing surfaces for Creator Packs on top of the Phase 1
backend rail. All surfaces HIDE entirely on builds without the release-injected
key (configured=false) so a fork never shows a broken install button.
- Backend: CreatorPackService.isConfigured() + `configured` flag on the
GET /api/creator-packs response; /settings/creator-packs route + controller
action.
- api client + useCreatorPacks hook (shared cached source of configured/packs/
downloads for every surface) + CreatorPackCard (status badges, art fallback,
update pill) + CreatorPacksSection (install-on-click grid + confirm modal with
the license note), reused by the Content Explorer block and settings page.
- Content Explorer: Creator Packs section before Additional Content.
- Settings: new /settings/creator-packs manage page + conditional nav item.
- Easy Setup wizard: new Creator Packs step after Content. Replaces the fragile
hardcoded AI-skip math with a computed activeSteps list so the two optional
steps (Creator Packs + AI) navigate correctly in every on/off combination;
selection state, storage projection, review summary, and finish-install wired.
Browser-tested on NOMAD3 across all surfaces (configured + fork paths), incl.
live install→download→cancel and AI-on/off wizard renumbering.
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
* feat(creator-packs): use branded pack banners on the cards
Replace the generic colored-block cards with the branded 1060x175 banners we
build into each pack ZIM, shown on both the settings page and the Easy Setup
wizard step (and the Content Explorer block, via the shared card).
- Bundle the seed-pack banners as local webp under admin/public/creator-packs/
so they render offline (no external image dependency, matching the existing
/rogue-support-banner.webp convention).
- CreatorPackCard is now banner-forward: the banner is the hero, with a compact
status/metadata footer (videos · size, Installed/Downloading/Selected/Install,
update pill). Falls back to a simple header if an image is ever missing.
- Prefer an optional catalog `banner_url` (future remote creators) over the
bundled-by-id path; add banner_url to the CreatorPack type + validator.
- Widen the card grids to 1–2 columns since banners are wide.
Browser-tested on NOMAD3: banners render on the settings page and wizard step;
selection/installed/downloading states and storage projection still correct.
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
* feat(creator-packs): Phase 3 — uninstall, license, release key-injection
Completes the Creator Packs feature.
- Uninstall: CreatorPackService.uninstallPack reuses ZimService.delete (removes
the ZIM, drops it from the Kiwix library, clears the InstalledResource) behind
DELETE /api/creator-packs/:id. A trash control on installed cards appears only
on the settings "manage" surface (allowUninstall) — never on the Content
Explorer block or the wizard — with a danger confirm modal.
- License: draft "Project NOMAD Creator Pack License v1.0" at
collections/creator-pack-license.md (marked DRAFT — pending legal review;
personal-use, no-redistribution, official-channel-only, creators retain
copyright). The install modal links to it ("View license").
- Release key-injection: Dockerfile ARG/ENV CREATOR_PACKS_APP_KEY in the runtime
stage (empty default → source/CI builds ship unconfigured and hide the UI) +
build-primary-image.yml passes it from the CREATOR_PACKS_APP_KEY CI secret.
NOTE FOR JAKE: add that repo secret = the entitlement Worker's key.
- Update flow was already functional (installed-with-update cards → "Update
pack"); verified.
Browser-tested on NOMAD3: uninstall round-trip (file + DB row + kiwix library
cleaned, then reinstalled), settings-only uninstall control, install-modal
license link, and the "Update available" pill via a temporary catalog bump.
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
* fix(downloads): clean up header merge logic
---------
Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Co-authored-by: jakeaturner <jturner@cosmistack.com>
108 lines
4.2 KiB
Docker
108 lines
4.2 KiB
Docker
FROM node:22-slim AS base
|
|
|
|
# Install bash & curl for entrypoint script compatibility, graphicsmagick for pdf2pic, and vips-dev & build-base for sharp
|
|
RUN apt-get update && apt-get install -y \
|
|
bash \
|
|
curl \
|
|
openssl \
|
|
graphicsmagick \
|
|
libvips-dev \
|
|
build-essential \
|
|
pciutils \
|
|
&& rm -rf /var/lib/apt/lists/*
|
|
|
|
# All deps stage
|
|
FROM base AS deps
|
|
WORKDIR /app
|
|
ADD admin/package.json admin/package-lock.json ./
|
|
RUN npm ci
|
|
|
|
# Production only deps stage
|
|
FROM base AS production-deps
|
|
WORKDIR /app
|
|
ADD admin/package.json admin/package-lock.json ./
|
|
RUN npm ci --omit=dev
|
|
|
|
# Build stage
|
|
FROM base AS build
|
|
WORKDIR /app
|
|
COPY --from=deps /app/node_modules /app/node_modules
|
|
ADD admin/ ./
|
|
RUN node ace build
|
|
|
|
# Production stage
|
|
FROM base
|
|
ARG VERSION=dev
|
|
ARG BUILD_DATE
|
|
ARG VCS_REF
|
|
ARG TARGETARCH
|
|
|
|
# go-pmtiles (regional map extracts). Pinned so the CLI's stdout format stays
|
|
# in sync with parseDryRunOutput().
|
|
ARG PMTILES_VERSION=1.30.2
|
|
# Upstream releases don't ship a checksums file, so pin per-arch SHA256 here.
|
|
# When bumping PMTILES_VERSION, regenerate these with:
|
|
# curl -fsSL <release-url> | sha256sum
|
|
ARG PMTILES_SHA256_AMD64=2cd3aa18868297fc88425038f794efdc0995e0275f4ca16fa496dd79e245a40c
|
|
ARG PMTILES_SHA256_ARM64=804cdf071834e1156af554c1a26cc42b56b9cde5a2db9c6e3653d16fb846d5fa
|
|
RUN set -eux; \
|
|
case "${TARGETARCH:-amd64}" in \
|
|
amd64) PMTILES_ARCH=x86_64; PMTILES_SHA256="${PMTILES_SHA256_AMD64}" ;; \
|
|
arm64) PMTILES_ARCH=arm64; PMTILES_SHA256="${PMTILES_SHA256_ARM64}" ;; \
|
|
*) echo "Unsupported TARGETARCH: ${TARGETARCH}" >&2; exit 1 ;; \
|
|
esac; \
|
|
TARBALL="go-pmtiles_${PMTILES_VERSION}_Linux_${PMTILES_ARCH}.tar.gz"; \
|
|
cd /tmp; \
|
|
curl -fsSL -o "$TARBALL" \
|
|
"https://github.com/protomaps/go-pmtiles/releases/download/v${PMTILES_VERSION}/${TARBALL}"; \
|
|
echo "${PMTILES_SHA256} ${TARBALL}" | sha256sum -c -; \
|
|
tar -xzf "$TARBALL" -C /usr/local/bin pmtiles; \
|
|
rm -f "$TARBALL"; \
|
|
chmod +x /usr/local/bin/pmtiles; \
|
|
/usr/local/bin/pmtiles version
|
|
|
|
# Labels
|
|
LABEL org.opencontainers.image.title="Project NOMAD" \
|
|
org.opencontainers.image.description="The Project NOMAD Official Docker image" \
|
|
org.opencontainers.image.version="${VERSION}" \
|
|
org.opencontainers.image.created="${BUILD_DATE}" \
|
|
org.opencontainers.image.revision="${VCS_REF}" \
|
|
org.opencontainers.image.vendor="Crosstalk Solutions, LLC" \
|
|
org.opencontainers.image.documentation="https://github.com/CrosstalkSolutions/project-nomad/blob/main/README.md" \
|
|
org.opencontainers.image.source="https://github.com/CrosstalkSolutions/project-nomad" \
|
|
org.opencontainers.image.licenses="Apache-2.0"
|
|
|
|
ENV NODE_ENV=production
|
|
|
|
# Creator Packs entitlement key, injected into OFFICIAL release builds at build
|
|
# time (--build-arg CREATOR_PACKS_APP_KEY=... from the CREATOR_PACKS_APP_KEY CI
|
|
# secret; see build-primary-image.yml). Baked as an ENV so admin/start/env.ts
|
|
# reads it at runtime. Empty by default, so builds from source (and any build
|
|
# without the secret) ship UNCONFIGURED and hide the Creator Packs UI. The key
|
|
# lands in this public image layer (extractable — the accepted ceiling); rotate
|
|
# via `wrangler secret put APP_KEY` + a new image if it leaks.
|
|
ARG CREATOR_PACKS_APP_KEY=""
|
|
ENV CREATOR_PACKS_APP_KEY=$CREATOR_PACKS_APP_KEY
|
|
|
|
WORKDIR /app
|
|
COPY --from=production-deps /app/node_modules /app/node_modules
|
|
COPY --from=build /app/build /app
|
|
# Generate version.json from the VERSION build-arg so the image tag is the
|
|
# single source of truth (previously copied root package.json, which drifted
|
|
# from the tag when semantic-release did not commit the bump back).
|
|
RUN echo "{\"version\":\"${VERSION}\"}" > /app/version.json
|
|
|
|
# Copy docs and README for access within the container
|
|
COPY admin/docs /app/docs
|
|
COPY README.md /app/README.md
|
|
|
|
# Empty Calibre library, seeded into storage/books on Calibre-Web install
|
|
# (see DockerService._runPreinstallActions__CalibreWeb)
|
|
COPY install/calibre-empty-library/metadata.db /app/assets/calibre/metadata.db
|
|
|
|
# Copy entrypoint script and ensure it's executable
|
|
COPY install/entrypoint.sh /usr/local/bin/entrypoint.sh
|
|
RUN chmod +x /usr/local/bin/entrypoint.sh
|
|
|
|
EXPOSE 8080
|
|
ENTRYPOINT ["/usr/local/bin/entrypoint.sh"] |