Files
afilmory/apps/docs/contents/builder/index.mdx
Innei b5fa9576a4 feat: enhance SaaS documentation and introduce health check module
- Added new documentation sections for SaaS architecture, deployment, and CMS functionality, detailing multi-tenant capabilities and live updates.
- Removed the outdated "Advanced SaaS Deployment" documentation in favor of a more streamlined approach.
- Introduced a health check module with endpoints to monitor the status of the database and Redis services, improving system reliability.

Signed-off-by: Innei <tukon479@gmail.com>
2025-11-23 20:44:15 +08:00

38 lines
1.6 KiB
Plaintext
Raw Blame History

This file contains invisible Unicode characters
This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
---
title: Builder
description: Overview of the photo pipeline and how to choose the right entrypoint for your run.
createdAt: 2025-11-14T22:10:00+08:00
lastModified: 2025-11-23T20:44:02+08:00
order: 40
---
# Builder
Builder is the unified pipeline (in `packages/builder`) that turns raw assets into the manifest and thumbnails the SPA consumes. It mirrors the “overview → entrypoint → options” cadence used by Vercels AI Gateway docs.
## What you get
- 600px JPEG thumbnail per photo + ThumbHash (`thumbHash`).
- `photos-manifest.json` sorted by capture time, plus `cameras[]`/`lenses[]` dictionaries.
- EXIF (incl. Fujifilm/Sony recipes), GPS, tone analysis, HDR, Motion Photo, and Live Photo markers.
- Optional plugins to sync or rewrite outputs (e.g., upload thumbnails, repo cache).
## How to run it
- **Quick switches:** per-run CLI flags (incremental, force, force-manifest, force-thumbnails, no-ui).
- **Defaults:** `builder.config.ts` for storage, concurrency, logging, plugins.
## Choose your path
- [CLI & run modes](/builder/cli) — flags, concurrency, cluster vs worker.
- [Configuration](/builder/config) — storage providers, system overrides, sample config.
- [Processing flow](/builder/pipeline) — incremental rules, ordering, manifest write-back.
- [Plugins](/builder/plugins) — lifecycle hooks, authoring your own plugin, examples.
- [Built-in plugins](/builder/built-ins) — shipped plugins ready to use.
- [SaaS Mode](/saas) — running Afilmory as a multi-tenant service.
## Prerequisites
- Node.js (workspace default) and **Perl** (required by `exiftool-vendored`).
- A valid `builder.config.ts` with at least one storage provider.