GKaszewski/movies-diary
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: add WRAPUP_BG_DIR to env/readme
Some checks failed
CI / Check / Test (push) Failing after 40s
Details

Browse Source
This commit is contained in:
Gabriel Kaszewski
2026-06-03 00:35:15 +02:00
parent d52120d6a9
commit 6fb00f9205
2 changed files with 4 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
.env.example
View File

@@ -65,6 +65,7 @@ EVENT_BUS_BACKEND=db
# Annual Wrap-Up (video generation — optional, requires ffmpeg) # Annual Wrap-Up (video generation — optional, requires ffmpeg)
# WRAPUP_FONT_PATH=/usr/share/fonts/truetype/dejavu/DejaVuSans.ttf # WRAPUP_FONT_PATH=/usr/share/fonts/truetype/dejavu/DejaVuSans.ttf
# WRAPUP_LOGO_PATH=./static/logo.webp # WRAPUP_LOGO_PATH=./static/logo.webp
# WRAPUP_BG_DIR=./static/wrapup-backgrounds # directory of jpg/png/webp images for video slide backgrounds
# FFMPEG_PATH=ffmpeg # FFMPEG_PATH=ffmpeg
# WRAPUP_MAX_CONCURRENT=2 # WRAPUP_MAX_CONCURRENT=2

5
README.md
View File

@@ -57,7 +57,7 @@ adapters/
postgres-event-queue — durable polling event queue backed by PostgreSQL postgres-event-queue — durable polling event queue backed by PostgreSQL
nats — NATS Core / JetStream event publisher and consumer nats — NATS Core / JetStream event publisher and consumer
event-publisher — in-memory event channel (used in tests) event-publisher — in-memory event channel (used in tests)
wrapup-renderer — annual wrap-up video generator (slide compositing via image crate, charts via plotters, stitching via ffmpeg) wrapup-renderer — annual wrap-up video generator (slide compositing via image/ab_glyph, stitching via ffmpeg)
activitypub — ActivityPub federation adapter (follow, inbox/outbox, actor); delegates to k-ap for protocol internals activitypub — ActivityPub federation adapter (follow, inbox/outbox, actor); delegates to k-ap for protocol internals
sqlite-search — SQLite FTS5 implementation of SearchPort + SearchCommand sqlite-search — SQLite FTS5 implementation of SearchPort + SearchCommand
postgres-search — PostgreSQL tsvector + GIN implementation of SearchPort + SearchCommand postgres-search — PostgreSQL tsvector + GIN implementation of SearchPort + SearchCommand
@@ -114,6 +114,7 @@ IMAGE_STORAGE_PATH=./images
# Annual Wrap-Up video (optional — requires ffmpeg) # Annual Wrap-Up video (optional — requires ffmpeg)
# WRAPUP_FONT_PATH=/usr/share/fonts/truetype/dejavu/DejaVuSans.ttf # WRAPUP_FONT_PATH=/usr/share/fonts/truetype/dejavu/DejaVuSans.ttf
# WRAPUP_LOGO_PATH=./static/logo.webp # watermark on video slides # WRAPUP_LOGO_PATH=./static/logo.webp # watermark on video slides
# WRAPUP_BG_DIR=./static/wrapup-backgrounds # slide background images (jpg/png/webp)
# FFMPEG_PATH=ffmpeg # FFMPEG_PATH=ffmpeg
# WRAPUP_MAX_CONCURRENT=2 # max parallel video renders # WRAPUP_MAX_CONCURRENT=2 # max parallel video renders
@@ -258,7 +259,7 @@ Omit `user_id` for a global instance wrap-up. The worker computes stats in the b
**Auto-generate:** The worker runs a daily job in January that generates wrap-ups for all users with reviews in the previous year. **Auto-generate:** The worker runs a daily job in January that generates wrap-ups for all users with reviews in the previous year.
**Video:** Requires `ffmpeg` installed. Set `WRAPUP_FONT_PATH` and `WRAPUP_LOGO_PATH` for branded slides. Download via `GET /api/v1/wrapups/{id}/video`. **Video:** Requires `ffmpeg` installed. Set `WRAPUP_FONT_PATH` and `WRAPUP_LOGO_PATH` for branded slides. Set `WRAPUP_BG_DIR` to a directory of background images for frutiger aero-style glass-panel slides. Cast profile photos and movie posters are embedded automatically. Download via `GET /api/v1/wrapups/{id}/video`.
## License ## License