mirror of
https://github.com/Afilmory/afilmory
synced 2026-04-24 23:05:05 +00:00
d5a2ea4db2
- Introduced a comprehensive `DEVELOPMENT.md` guide for contributors and self-hosters, detailing workspace layout and common commands. - Updated `README.md` to include links to the new development guide and improved deployment instructions. - Added new documentation files covering architecture, builder pipeline, configuration, and deployment strategies. - Implemented new storage provider documentation for Backblaze B2, Eagle, GitHub, and local storage options. - Enhanced the UI components with new features, including a navigation context and improved theme handling. - Removed outdated GitHub Action deployment documentation. Signed-off-by: Innei <tukon479@gmail.com>
44 lines
1.1 KiB
Markdown
44 lines
1.1 KiB
Markdown
# Deployment & Hosting
|
|
|
|
## Option A: Docker (recommended)
|
|
|
|
Use the prebuilt images and guide at https://github.com/Afilmory/docker for the fastest setup.
|
|
|
|
## Option B: Manual
|
|
|
|
1) Prepare configs
|
|
- Copy `config.example.json` → `config.json`, fill site info and map settings.
|
|
- Copy `builder.config.default.ts` → `builder.config.ts`, set storage provider/credentials.
|
|
- Add environment variables in `.env` (storage + optional repo sync).
|
|
|
|
2) Build manifest and thumbnails
|
|
|
|
```bash
|
|
pnpm run build:manifest # incremental
|
|
pnpm run build:manifest -- --force # full rebuild
|
|
```
|
|
|
|
3) Run servers
|
|
|
|
```bash
|
|
pnpm dev # SPA + SSR
|
|
pnpm --filter web dev # SPA only
|
|
```
|
|
|
|
4) Production build
|
|
|
|
```bash
|
|
pnpm build
|
|
```
|
|
|
|
### Storage Notes
|
|
|
|
- S3-compatible endpoints work out of the box; set `customDomain` if you serve assets via CDN.
|
|
- Local-only testing: set `storage.provider` to `local` with `basePath`/`baseUrl`.
|
|
- GitHub/B2/Eagle providers are available—see `builder.config.default.ts` for examples.
|
|
|
|
### Manifest Outputs
|
|
|
|
- `apps/web/public/thumbnails` (generated thumbnails)
|
|
- `apps/web/src/data/photos-manifest.json` (metadata used by SPA/SSR)
|