From 8bf1d753aad95a22312342b5d0f97226ab3144f2 Mon Sep 17 00:00:00 2001 From: Alan Grainger <16197738+alangrainger@users.noreply.github.com> Date: Mon, 19 Oct 2026 14:25:55 +1300 Subject: [PATCH] #307 Add `ipp.upload.notice` for a customisable notice on the upload page --- docs/config/upload-service.md | 11 +++++++++++ docs/visitor-uploads.md | 4 +++- upload-app/config.json | 1 + upload-app/public/style.css | 20 ++++++++++---------- upload-app/src/client/upload.ts | 2 -- upload-app/src/config.ts | 6 ++++++ upload-app/src/index.ts | 5 +++-- upload-app/src/view/upload.tsx | 6 ++++-- upload-app/tests/config.test.ts | 10 +++++++++- 9 files changed, 47 insertions(+), 18 deletions(-) diff --git a/docs/config/upload-service.md b/docs/config/upload-service.md index fb79b48..ea4afee 100644 --- a/docs/config/upload-service.md +++ b/docs/config/upload-service.md @@ -87,6 +87,17 @@ Added to the start of every stored filename: `IMG_0042.jpg` is stored as `ipp_up what an Immich workflow can match on; see [Tag uploaded photos](/tag-and-review-uploads#tag-uploaded-photos). Set it to `""` to store the visitor's filename unchanged. +### `notice` + +**Type:** `string` · **Default:** `"Uploaded photos may not appear in the gallery immediately."` + +A short line of text shown below the upload area, letting visitors know their photos won't show up in the gallery +straight away. It's visible the whole time the page is open, so visitors read it before they upload as well as after. +Set it to `""` to hide it. + +The text is shown exactly as written, without HTML or links, so you can translate it into your gallery's language. The +reason for the delay is explained in [When do uploads appear](/visitor-uploads#when-do-uploads-appear). + ### `notifyUrl` **Type:** `string` · **Default:** `""` diff --git a/docs/visitor-uploads.md b/docs/visitor-uploads.md index 4b16030..de6df02 100644 --- a/docs/visitor-uploads.md +++ b/docs/visitor-uploads.md @@ -319,7 +319,9 @@ The owner sees them in Immich at once. Other visitors see them in the gallery on 3. The visitor's browser has fetched the gallery page again. It keeps the page for [`gallery.cacheTime`](/config/gallery#cachetime), 5 minutes by default. -So a new photo can take up to about 7 minutes to show for a visitor who already had the gallery open. +So a new photo can take up to about 7 minutes to show for a visitor who already had the gallery open. The upload page +includes a short notice to let visitors know about the delay; you can change the wording or hide it with the +[`notice`](/config/upload-service#notice) option. ### What happens when a visitor sends a photo the owner already has diff --git a/upload-app/config.json b/upload-app/config.json index d0aeea7..9bde8a3 100644 --- a/upload-app/config.json +++ b/upload-app/config.json @@ -7,6 +7,7 @@ "rateLimit": 60, "byteBudget": 10240, "filenamePrefix": "ipp_upload_", + "notice": "Uploaded photos may not appear in the gallery immediately.", "notifyUrl": "", "notifyHeaders": {}, "notifyTimeout": 10000 diff --git a/upload-app/public/style.css b/upload-app/public/style.css index a556832..17a2d25 100644 --- a/upload-app/public/style.css +++ b/upload-app/public/style.css @@ -71,6 +71,15 @@ html.dark .upload-placeholder:focus-visible { opacity: 0.7; } +/* The owner's notice, from ipp.upload.notice */ +.upload-notice { + margin: -8px 0 0; + font-size: 14px; + font-weight: 300; + text-align: center; + opacity: 0.7; +} + /* Nothing to drop on a touch screen */ @media (hover: none) { .upload-drop-hint { @@ -97,21 +106,12 @@ html.dark .upload-placeholder:focus-visible { font-weight: 500; } -#upload-counts, -#upload-note { +#upload-counts { margin: 0; font-size: 12px; opacity: 0.8; } -#upload-note { - margin-top: 4px; -} - -#upload-note[hidden] { - display: none; -} - .upload-count-success { color: var(--color-success); } .upload-count-danger { color: var(--color-danger); } .upload-count-warning { color: var(--color-warning); } diff --git a/upload-app/src/client/upload.ts b/upload-app/src/client/upload.ts index 078381f..060db8a 100644 --- a/upload-app/src/client/upload.ts +++ b/upload-app/src/client/upload.ts @@ -32,7 +32,6 @@ const run = createLimiter(CONCURRENT_UPLOADS) const panelEl = document.getElementById('upload-panel') as HTMLElement const progressEl = document.getElementById('upload-progress') as HTMLElement const countsEl = document.getElementById('upload-counts') as HTMLElement -const noteEl = document.getElementById('upload-note') as HTMLElement const listEl = document.getElementById('upload-list') as HTMLElement const dropEl = document.getElementById('upload-drop') as HTMLElement @@ -72,7 +71,6 @@ function updateSummary () { uploaded.textContent = String(stats.uploaded) errors.textContent = String(stats.errors) duplicates.textContent = String(stats.duplicates) - noteEl.hidden = stats.remaining > 0 || stats.uploaded === 0 } function setState (row: UploadRow, state: RowState) { diff --git a/upload-app/src/config.ts b/upload-app/src/config.ts index f0a3552..ed5b6e7 100644 --- a/upload-app/src/config.ts +++ b/upload-app/src/config.ts @@ -32,6 +32,12 @@ export function filenamePrefix (): string { return typeof configured === 'string' ? configured : '' } +/** Text shown under the placeholder on the upload page, from `ipp.upload.notice`. Empty hides it. */ +export function uploadNotice (): string { + const configured = getConfigOption('ipp.upload.notice', 'Uploaded photos may not appear in the gallery immediately.') + return typeof configured === 'string' ? configured : '' +} + /** Notification webhook settings from `ipp.upload.notify*`, or undefined when no URL is set. */ export function notifyConfig (): { url: string, headers: Record, timeoutMs: number } | undefined { const url = getConfigOption('ipp.upload.notifyUrl', '') diff --git a/upload-app/src/index.ts b/upload-app/src/index.ts index 8921a50..92d7f03 100644 --- a/upload-app/src/index.ts +++ b/upload-app/src/index.ts @@ -28,7 +28,7 @@ import { title, unlockHandler } from '@ipp/core' -import { galleryUrl, maxFileSize } from './config' +import { galleryUrl, maxFileSize, uploadNotice } from './config' import { uploadAllowed } from './gate' import { createUploadReceiver } from './receive' import { getShare } from './share' @@ -142,7 +142,8 @@ router.get('/:shareType(share|s)/:key', decodeCookie, asyncHandler(async (req, r title: title(resolved.link) }, basePath: req.baseUrl, - galleryLink: gallery && `${gallery}/${req.params.shareType}/${encodeURIComponent(key)}` + galleryLink: gallery && `${gallery}/${req.params.shareType}/${encodeURIComponent(key)}`, + notice: uploadNotice() }))) })) diff --git a/upload-app/src/view/upload.tsx b/upload-app/src/view/upload.tsx index c76ed3a..dac5bd2 100644 --- a/upload-app/src/view/upload.tsx +++ b/upload-app/src/view/upload.tsx @@ -9,6 +9,8 @@ export interface UploadPageProps { basePath: string /** This share's gallery on IPP, when `PUBLIC_BASE_URL` is set. */ galleryLink?: string + /** Plain text shown under the placeholder. Empty hides it. */ + notice: string } function Icon ({ path, class: className }: { path: string, class?: string }) { @@ -24,7 +26,7 @@ function Icon ({ path, class: className }: { path: string, class?: string }) { * gallery's header, a placeholder to click or drop on, and an upload panel * the client fills. */ -export function UploadPage ({ config, basePath, galleryLink }: UploadPageProps) { +export function UploadPage ({ config, basePath, galleryLink, notice }: UploadPageProps) { const staticPath = `${basePath}/share/static/${ASSET_VERSION}` return ( @@ -55,11 +57,11 @@ export function UploadPage ({ config, basePath, galleryLink }: UploadPageProps) Add photos Choose photos and videos, or drop them here + {notice &&

{notice}

} diff --git a/upload-app/tests/config.test.ts b/upload-app/tests/config.test.ts index f500524..54843cd 100644 --- a/upload-app/tests/config.test.ts +++ b/upload-app/tests/config.test.ts @@ -1,5 +1,5 @@ import { describe, it, expect, afterEach } from 'vitest' -import { byteBudget, filenamePrefix, maxFileSize, notifyConfig } from '../src/config' +import { byteBudget, filenamePrefix, maxFileSize, notifyConfig, uploadNotice } from '../src/config' import { resetConfig, setConfig } from './helpers' afterEach(resetConfig) @@ -12,6 +12,14 @@ describe('upload options', () => { expect(byteBudget()).toBe(10240 * MB) expect(filenamePrefix()).toBe('ipp_upload_') expect(notifyConfig()).toBeUndefined() + expect(uploadNotice()).toBe('Uploaded photos may not appear in the gallery immediately.') + }) + + it('shows the owner\'s notice, and hides one that is not a string', () => { + setConfig({ ipp: { upload: { notice: 'Les photos apparaissent plus tard.' } } }) + expect(uploadNotice()).toBe('Les photos apparaissent plus tard.') + setConfig({ ipp: { upload: { notice: false } } }) + expect(uploadNotice()).toBe('') }) it('never lets maxFileSize reach zero, which would refuse every file', () => {