From 9ad99cb91b5b5a576076c93f6e99576bad22df60 Mon Sep 17 00:00:00 2001 From: Alan Grainger <16197738+alangrainger@users.noreply.github.com> Date: Wed, 7 Oct 2026 16:45:17 +1300 Subject: [PATCH] Update docs --- docs/public/visitor-uploads.svg | 82 +++++++++++++++++++++++++++++++++ docs/visitor-uploads.md | 4 +- 2 files changed, 85 insertions(+), 1 deletion(-) create mode 100644 docs/public/visitor-uploads.svg diff --git a/docs/public/visitor-uploads.svg b/docs/public/visitor-uploads.svg new file mode 100644 index 0000000..5b9e711 --- /dev/null +++ b/docs/public/visitor-uploads.svg @@ -0,0 +1,82 @@ + + + + + + + + + + + + + + + + + + Visitor's browser + + + + + gallery, thumbnails, video + /upload/… upload page, healthcheck, + one POST per file + + + + Your reverse proxy + everything else + /upload/* (or its own hostname) + + + + + + + + immich-public-proxy + read-only, unchanged + Renders the gallery as today. + Shows an Add photos button when the share + allows uploads in Immich and the upload + service answers at /upload/healthcheck. + Never accepts a file. Never writes to Immich. + + + + immich-public-proxy-upload + optional second container + Serves the upload page for the share. + Checks the share, rate and size limits, + filename and type, then streams each file + straight to Immich. + Stores nothing. Never serves gallery content. + + + + link + + + + share key, read + GET /shared-links/me + GET /timeline, /assets + + + share key, write + GET /shared-links/me + POST /assets + + + + Immich + Refuses an upload unless Allow public user to upload is on for the share. + Stores the file as the owner's and adds it to the album or shared link. + Makes the thumbnail. IPP shows the photo on its next cache refresh. + + + Neither container holds an Immich API key, a database or a volume. Both use the visitor's own share key. + + diff --git a/docs/visitor-uploads.md b/docs/visitor-uploads.md index 66695cf..b84a5a0 100644 --- a/docs/visitor-uploads.md +++ b/docs/visitor-uploads.md @@ -22,10 +22,12 @@ This guide assumes IPP is already [installed](/installation) behind a reverse pr ## How it works Uploads are handled by a second, optional container, `immich-public-proxy-upload`. The IPP container stays -read-only. +read-only. **No API key is required.** +How visitor uploads work: the browser reaches the reverse proxy, which sends gallery requests to the read-only immich-public-proxy container and /upload requests to the optional immich-public-proxy-upload container. Both talk to Immich with the visitor's share key. Immich refuses uploads unless the share allows them, stores the file and adds it to the album or link. + 1. In Immich, the owner turns on **Allow public user to upload** for a shared link. The gallery for that share then shows an **Add photos** button. 2. A visitor clicks the button. It opens the upload page for the same share on the upload service's separate container.