Files
immich-folio/docs/gallery-config.md
Ralksta 3193c500e4 release: v0.18.0 (#725)
Release v0.18.0 — merges `dev` into `main`.

## Thanks

- [@lancetm714](https://github.com/lancetm714) for the accent-contrast
fix (#680 → #724).
- [@RichKidsDev](https://github.com/RichKidsDev) for reporting the
outdated Impressum (#697).

### Security

- **Journal drafts and password-protected entries no longer render
publicly
  as a subpage essay**
  ([#684](https://github.com/ralksta/immich-folio/pull/684),

[GHSA-987w-cpwm-c9g9](https://github.com/ralksta/immich-folio/security/advisories/GHSA-987w-cpwm-c9g9),
medium). A subpage's `essayFile` read the journal entry straight from
disk,
skipping the draft and password rules `/journal/<slug>` applies. It now
resolves through the same rules: a draft reads as missing for visitors,
and
  a protected entry shows its password gate, sharing the
  `lb_auth_journal_<slug>` cookie.

- **Immich descriptions are escaped in generated subpage essays**
  ([#684](https://github.com/ralksta/immich-folio/pull/684),

[GHSA-8ppx-39jv-q5xm](https://github.com/ralksta/immich-folio/security/advisories/GHSA-8ppx-39jv-q5xm),
  low). The essay built from a subpage's albums (`layout: essay` without
markdown) put each asset's Immich description into the page as raw HTML.
Captions are now HTML-escaped, and they go through `assetCaption()`, so
  `exif.caption: false` is respected there as well. Tracked in
  [#689](https://github.com/ralksta/immich-folio/issues/689).

- **Admin drafts no longer keep a typed password, and the contact form's
  email check runs in linear time**
([#727](https://github.com/ralksta/immich-folio/pull/727)). The admin's
  session drafts wrote a password as typed to `sessionStorage`; a draft
holding a plaintext password is now not kept (the unsaved-changes guard
still warns). The email pattern could backtrack polynomially on a
crafted
domain; its labels now exclude the dot and the length is checked first.
  Both found by CodeQL before release.

### Added

- **A built-in contact form with an inbox in the admin**
  ([#703](https://github.com/ralksta/immich-folio/pull/703), closes
[#702](https://github.com/ralksta/immich-folio/issues/702)). `/contact`
  needs neither SMTP nor a form service: each message is one file in
`content/messages/` (mode `0600`), read under the new _Messages_ tab,
where
_Reply by email_ opens the owner's mail client with the message quoted.
Messages older than `contact.retentionDays` (default 90) are deleted. An
optional ntfy push goes to `contact.notifyUrl` or `CONTACT_NOTIFY_URL`,
and
since [#709](https://github.com/ralksta/immich-folio/pull/709) it
carries a
  fixed "new message" line and nothing about the sender — no name, no
  address, no text. Spam is kept out without a captcha: an off-screen
honeypot, a minimum fill time, three submissions a minute per IP and a
cap
of 500 stored messages. With the Impressum on and no `legal.contactUrl`,
the Impressum links the form as its second contact channel. A new doctor
  check warns when the form is on but nobody is notified.

- **A privacy policy page, next to a list of what the site processes**
  ([#708](https://github.com/ralksta/immich-folio/pull/708)). `/privacy`
renders `content/privacy.md`, edited under Settings → Legal, and the
footer
links it once the file has text; `privacy.enabled: false` hides it.
Folio
writes no legal text. Beside the editor it lists what _this_
installation
  does, read off the configuration — the map, statistics, contact form,
password cookies, CDN — and marks every entry that involves a third
party.
_Insert headings_ adds the matching section headings and nothing else.
The
  doctor warns while the Impressum is on and there is no policy.

- **French, Spanish, Italian and Dutch interface translations**
([#681](https://github.com/ralksta/immich-folio/pull/681)), selected
with
  `settings.yaml: lang` as before. The admin panel stays English.

- **CDN mode for photos and videos**
([#681](https://github.com/ralksta/immich-folio/pull/681)). With
`CDN_URL`
set, image and video URLs point at a pull CDN whose origin is this
server,
  so repeat views reach neither the server nor Immich. A site password
switches the mode off, since a CDN would hand out cached photos without
  checking the unlock cookie. The CDN origin is added to the CSP, and a
  doctor check covers the password and `TRUSTED_PROXY_HOPS` cases. See
  `docs/deployment.md#cdn-mode`.

- **A reworked admin panel**
  ([#712](https://github.com/ralksta/immich-folio/pull/712),
  [#713](https://github.com/ralksta/immich-folio/pull/713),
  [#714](https://github.com/ralksta/immich-folio/pull/714),
  [#716](https://github.com/ralksta/immich-folio/pull/716),
  [#717](https://github.com/ralksta/immich-folio/pull/717),
  [#718](https://github.com/ralksta/immich-folio/pull/718),
  [#719](https://github.com/ralksta/immich-folio/pull/719),
  [#721](https://github.com/ralksta/immich-folio/pull/721)):
- **A sidebar instead of the header row**, grouped by task, with an
unread
    count on Messages and a dot on Diagnostics while Immich is down. It
    collapses to an icon rail, with names shown on hover and focus, and
    remembers that per browser.
  - **`/admin` is an overview**: what needs attention (unread messages,
    doctor warnings), published pages, journal entries and recent views.
  - **The site's own visual language** — the preset's fonts, hairline
borders, the square marker — and one page header on every screen. The
accent is kept for the current place and the primary action; switches
    are now pills reading ON or OFF, in green rather than the accent, so
    Studio Modern's red no longer makes an enabled setting look like an
    error.
- **The page builder is a structure list and a panel.** Hero, subpages
and
standalone albums sit in one list on the left, subpages drag-sorted in
    place; the selected entry is edited on the right instead of in an
    overlay.
- **Dialogs only where a change is permanent.** Deleting a message or a
journal entry, and resetting the favicon (which used to delete the file
without asking), go through one confirm dialog in the admin's own look.
Removals in the page builder, which only touch unsaved state, happen at
    once and offer _Undo_. No `window.confirm()` is left.
  - **Feature switches are grouped by meaning** as one-line rows under
Settings → General; page transitions and scroll-to-top moved to Theme →
    Look & motion. No setting keys changed.

### Changed

- **Fonts and the Leaflet stylesheet are served from the site itself**
([#700](https://github.com/ralksta/immich-folio/pull/700)). Every page
used
to link `fonts.googleapis.com`, which sends each visitor's IP address to
Google. The server now fetches a theme's Google fonts once, rewrites the
  stylesheet and caches the files in `content/.fonts/`; custom fonts in
`theme.fonts` keep working. If Google cannot be reached before a font is
  cached, the page falls back to the theme's system fonts. `leaflet.css`
  comes from the npm package instead of unpkg. The CSP drops
  `fonts.googleapis.com`, `fonts.gstatic.com` and `unpkg.com`.

- **Email addresses are kept out of the served HTML**
([#705](https://github.com/ralksta/immich-folio/pull/705)). The
Impressum
and footer render the address only after hydration, from an encoded
form,
  so harvesters reading raw HTML find nothing. Without JavaScript the
Impressum shows `name [at] example [dot] de`. This defeats bulk
harvesting,
  not a person with a browser.

- **The Impressum cites § 5 DDG and links its contacts**
  ([#698](https://github.com/ralksta/immich-folio/pull/698), reported in
  [#697](https://github.com/ralksta/immich-folio/issues/697) by
[@RichKidsDev](https://github.com/RichKidsDev)). The TMG was replaced by
the
DDG in May 2024; `legal.heading` replaces the line for other laws (e.g.
  § 5 ECG in Austria). `legal.contactUrl` and `legal.contactLabel` add a
  contact form as the second channel, so a phone number stays optional.
  Email, phone and contact URL are now links, and the "Created with the
Impressum generator by eRecht24" line, shown on every site whether true
or
not, is gone. Settings → Legal gains fields for heading, contact URL,
VAT
  ID and tax number, and a doctor check flags missing details.

- **Missing pages answer `404`**
([#704](https://github.com/ralksta/immich-folio/pull/704)). Every
missing
  page used to answer `200`, because streaming had started before
`notFound()` ran. `/contact`, `/impressum`, `/map` and `/privacy` while
switched off, and `/journal/<slug>` without an entry, now return a real
404 with the same not-found page. Album and subpage slugs still depend
on
  Immich and stay soft 404s.

- **Passwords set in the admin are stored as scrypt hashes**
  ([#706](https://github.com/ralksta/immich-folio/pull/706), closes
  [#690](https://github.com/ralksta/immich-folio/issues/690)). Subpage,
album, journal-entry and site passwords were written as typed. The save
routes now hash them; a stored hash reads _Protected_ with _Change_ and
_Remove_ and is never put into an input. Visitors who unlocked a page
stay
signed in across unrelated saves. Existing plaintext passwords are
hashed
  the next time their file is saved in the admin.

- **One notification surface in the admin**
([#707](https://github.com/ralksta/immich-folio/pull/707)) replaces
every
`alert()`: errors stay until dismissed, successes clear themselves, and
  screen readers announce both.

### Fixed

- **Map tiles load again**
([#701](https://github.com/ralksta/immich-folio/pull/701)). CARTO
started
answering every tile with an "API KEY REQUIRED" image, leaving `/map`
and
journal map blocks as a grey grid. Tiles now come from OpenStreetMap;
the
  dark look is a CSS filter, so the map now follows the colour mode.

- **The page builder no longer drops a subpage's `proofing:` flag on
save**
([#711](https://github.com/ralksta/immich-folio/pull/711)). A page
switched
  off for proofing by hand reverted after any unrelated edit.

- **Unsaved edits in Settings and About survive switching admin tabs,
and a
  backup restore is no longer overwritten by the next save**
([#687](https://github.com/ralksta/immich-folio/pull/687)). Editors that
were open during a restore now reload and offer unsaved edits back as a
  conflict. Also: "Restore my changes" after a conflict found nothing,
removing an album left its drawer showing the next album, and the
journal
  saved (rotating a backup) without changes.

- **Accent-backed buttons stay readable with a light or malformed
accent**
  ([#724](https://github.com/ralksta/immich-folio/pull/724), supersedes
[#680](https://github.com/ralksta/immich-folio/pull/680)) — contributed
by
  [@lancetm714](https://github.com/lancetm714). A white accent made the
  proofing dialog's _Download selected (.zip)_ button white on white.
`theme.accent` is now accepted as hex only and normalised to `#rrggbb`,
anything else falls back to the preset, and the proofing dialog and
filter
  pills use the mode-aware `--on-accent` text colour from #688.

- **Every preset's accent is visible in both colour modes**
([#688](https://github.com/ralksta/immich-folio/pull/688)). Presets had
one
accent for both modes; minimal's dark mode drew black buttons on black.
  Presets now carry a light and a dark accent, and text on accent-filled
  buttons picks black or white for contrast. A custom accent stays the
  owner's choice in both modes.

- **Visitor-side inconsistencies**
([#685](https://github.com/ralksta/immich-folio/pull/685)): after
visiting
`/impressum`, every subpage header turned centred and uppercase; back
links
  announced "Back to Back to …"; the hero EXIF chip ignored
`exif.location`/`camera`/`settings`; videos in journal entries opened as
  stills; the setup screen named a non-existent `.env.example`.

- **An essay's lightbox walks only the photos the story shows**
([#686](https://github.com/ralksta/immich-folio/pull/686)), not every
photo
of the subpage's albums, and the proofing bar in essays shows the
selection
  count instead of a filter button that did nothing.

- **The page panel scrolls with the mouse wheel**
  ([#720](https://github.com/ralksta/immich-folio/pull/720)).

- **The journal editor's top bar wraps on phones**
  ([#723](https://github.com/ralksta/immich-folio/pull/723), closes
[#675](https://github.com/ralksta/immich-folio/issues/675)), so the
title
  stays editable and Save stays on screen.

- **Every admin form field has a name for assistive technology**
([#715](https://github.com/ralksta/immich-folio/pull/715)). Only two
inputs
had a linked label; 47 are linked now, and clicking a label focuses its
  field.

### Internal

- **`SettingsEditor` and `PageBuilder` are split up**
  ([#710](https://github.com/ralksta/immich-folio/pull/710),
[#711](https://github.com/ralksta/immich-folio/pull/711)). The
2,200-line
settings editor is a shell with one file per section; the page builder's
YAML handling and edits are pure functions under test. Both were checked
  side by side against `dev` for identical output.
- **`useAdminFetch()`**
([#707](https://github.com/ralksta/immich-folio/pull/707))
gives Analytics, Messages, Backups and the journal list one loading and
  error pattern.
- README brought up to v0.17.0
  ([#678](https://github.com/ralksta/immich-folio/pull/678),
  [#679](https://github.com/ralksta/immich-folio/pull/679)).

### Upgrade notes

**`content/` gains two directories the app writes to:**
`content/.fonts/`
for the cached fonts and `content/messages/` for contact-form messages.
Both
are created on demand, so a writable `content/` is enough, as before.

**The server needs outbound HTTPS to Google once per font** to fill the
font
cache. Until then pages fall back to the theme's system fonts. Visitors'
browsers no longer contact Google.

**A custom CSP or reverse-proxy allowlist** must now allow
`tile.openstreetmap.org` for images instead of
`*.basemaps.cartocdn.com`,
and no longer needs `fonts.googleapis.com`, `fonts.gstatic.com` or
`unpkg.com`. The built-in CSP is updated.

**`theme.accent` must be hex** (`#rgb`, `#rrggbb` or `#rrggbbaa`).
Anything
else, including a value without `#`, falls back to the preset's accent.

**Plaintext passwords in `gallery.yaml`, `settings.yaml` or journal
entries**
are hashed the next time that file is saved in the admin; one save
clears the
doctor's warning.

**New, optional settings:** `contact.*` (the form is off by default),
`privacy.enabled`, `legal.heading`, `legal.contactUrl`,
`legal.contactLabel`,
and the `CDN_URL` and `CONTACT_NOTIFY_URL` environment variables. See
`content/settings.yaml.example` and `.env.local.example`. In the example
file,
`vatId` and `taxId` had swapped sample values; check yours if you copied
them.

No `IMAGE_CACHE_VERSION` bump is needed this time.

---------

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: ralksta <ralksta@users.noreply.github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Claude Opus 5 <noreply@anthropic.com>
Co-authored-by: Ralf <rohlenbo79@gmail.com>
Co-authored-by: Paul Thies <110185070+ImScheinox@users.noreply.github.com>
Co-authored-by: lancetm714 <108419425+lancetm714@users.noreply.github.com>
Co-authored-by: Lance Martin <lancetaylor95@gmail.com>
2026-09-27 14:43:38 +02:00

34 KiB
Raw Blame History

Gallery Configuration

Configuration is split across two files in content/:

File Contains
gallery.yaml Structure — hero assets, albums, subpages, sections, per-album settings
settings.yaml Behaviour and identity — title, theme, grid defaults, footer, legal, SEO

Copy the examples to get started:

cp content/gallery.yaml.example content/gallery.yaml
cp content/settings.yaml.example content/settings.yaml

settings.yaml is optional — without it, everything falls back to defaults.

Tip

Prefer a visual interface? Enable the Admin Panel by setting ADMIN_PASSWORD in your environment. It provides a drag-and-drop page builder that writes to these same YAML files automatically.

Contents:

gallery.yaml

settings.yaml

Other

Hero Images

Single image or crossfade carousel on the homepage:

# Single hero image
hero: 00000000-0000-0000-0000-000000000000

# Carousel (crossfade between multiple images)
hero:
  - 00000000-0000-0000-0000-000000000000
  - 11111111-1111-1111-1111-111111111111
  - 22222222-2222-2222-2222-222222222222

Standalone Albums

Albums shown directly on the homepage as cards.

Note

The thumbnail image for each album grid card is automatically synced with the explicit "Cover Image" you select for that album inside the Immich Web UI.

albums:
  - 11111111-1111-1111-1111-111111111111
  - 22222222-2222-2222-2222-222222222222

Subpages

Group multiple albums into named collections. URLs are auto-generated from the name. The overall Subpage Cover Image shown on the homepage is automatically inherited from the Cover Image of the first album inside its list.

subpages:
  - name: Japan # → /japan
    title: 'Trip to Japan' # Optional: overrides the page heading
    subtitle: '2024 adventures' # Optional: adds a subline under the heading
    albums:
      - 33333333-3333-3333-3333-333333333333 # Tokyo
      - 44444444-4444-4444-4444-444444444444 # Kyoto

  - name: Wedding – Smith # → /wedding-smith
    password: clientpass123 # Optional: subpage-level protection
    albums:
      - 55555555-5555-5555-5555-555555555555
      - 66666666-6666-6666-6666-666666666666:
          title: 'Private Highlights'
          password: 'album-secret-123' # Optional: album-level protection

Alternatively, you can use the object notation (recommended):

subpages:
  'Japan':
    title: 'Trip to Japan'
    subtitle: '2024 adventures'
    albums:
      - 33333333-3333-3333-3333-333333333333

Subpage Options

Key Type Description
name string Navigation label; the URL slug is derived from it
title string Page heading, defaults to name
subtitle string Subline under the heading
password string Gates the whole subpage — see Password Protection
albums list Album UUIDs, optionally with per-album options
sections list Named groups of albums — see Sections
grid object Grid override for the photos on this page — see Grid Layout
coverGrid object Grid override for the album covers on this page — see Album covers
proofing boolean Enables client proofing on this page
essayFile string Render a Markdown essay instead of a grid — see Journal & Photo Essays
essayText string Essay Markdown inline; written by the admin block editor
enabled boolean false takes the page offline without deleting it
hidden boolean Experimental. Reachable by direct link, but hidden from the navigation
subpages:
  - name: Client Preview
    hidden: true # unlisted: not in the nav, still reachable at /client-preview
    proofing: true # visitors can mark favourites and export the selection
    password: 'clientpass123'
    albums:
      - 55555555-5555-5555-5555-555555555555

  - name: Old Series
    enabled: false # offline, keeps its configuration
    albums:
      - 66666666-6666-6666-6666-666666666666

Note

hidden is unlisting, not access control. The URL is guessable — a slug is derived from the name — and nothing stops a visitor who has it. Combine it with password for anything that must stay private.

Sections

When a subpage contains many albums you can split them into named sections. A typographic table of contents with anchor links is automatically rendered above the albums. Sections are fully optional — omit them and you get the standard flat grid.

Each section can have:

Field Type Required Description
title string ✅ Section heading + anchor name
description string ➖ Optional subline under the heading
albums list ✅ Album UUIDs (same format as regular albums)

Within the albums list you can use a plain UUID, a simple title override, or an object — see Per-Album Options.

Full example:

subpages:
  - name: Japan
    title: Japan
    subtitle: 'Travel through a land full of contrasts.'
    sections:
      - title: Tokyo
        description: 'Megacity, neon lights, silence in the noise.'
        albums:
          - '33333333-3333-3333-3333-333333333333'
          - '44444444-4444-4444-4444-444444444444': Shinjuku at night

      - title: Kyoto
        description: 'Temples and bamboo forests.'
        albums:
          - '55555555-5555-5555-5555-555555555555': Fushimi Inari
          - '66666666-6666-6666-6666-666666666666'

      - title: Osaka
        albums: # description is optional
          - '77777777-7777-7777-7777-777777777777'

Note

Each section title is automatically converted to a URL-safe anchor (#tokyo, #kyoto, …). The TOC appearance (separator character, numbering style, section rule) is fully controlled by the active theme.

Per-Album Options

Every album entry — standalone, on a subpage, or inside a section — accepts the same three notations:

albums:
  - 'album-uuid' # → uses the Immich album name
  - 'album-uuid': My Title # → displays "My Title" instead
  - 'album-uuid':
      title: My Private Title
      description: 'Shot on 35mm film in Vienna, spring 2025.'
      password: 'secure-password'
      heroImage: 'asset-uuid'
      sort: filename
      download: true
Key Description
title Display name instead of the Immich album name
description Shown below the album title
password Gates this album alone — see Password Protection
heroImage Asset UUID overriding the album cover
sort Photo order — see Photo Order Within an Album
assetOrder Pinned asset UUIDs for sort: manual
grid Experimental. Grid override for this album only
coverPosition Experimental. Focal point for the cover crop
download Offer originals for download — see Originals download

Per-album grid (experimental)

An album can override the grid it is shown in. It is merged over the subpage grid, which is merged over the global default — so an album only has to state what differs:

albums:
  - 'album-uuid':
      title: Panoramas
      grid:
        layout: justified
        columns: 2

Cover focal point (experimental)

Album covers are cropped to the card. coverPosition decides which part survives the crop — the same values CSS object-position takes:

albums:
  - 'album-uuid':
      coverPosition: '50% 25%' # or: "top", "center bottom", "left"

Useful when the automatic centre crop cuts off a horizon or a face.

Originals download

Opt in per album with download: true. Off everywhere by default, and opt-in on purpose: a public portfolio should not start handing out full-resolution originals because one client gallery needed to.

albums:
  - 'album-uuid':
      download: true

Once enabled, visitors get a Download album link in the album header (every original as a ZIP), and — where client proofing is on — a Download selected (.zip) action in the export dialog that zips just the favourited photos.

The download route re-checks the allowlist, the download flag, every password gate on a route to the album, and that each asset really belongs to that album, so an edited URL cannot reach anything else. The ZIP keeps the original filenames (deduplicated on collision) and is streamed, so album size does not drive memory use.

Password Protection

A password can be set on the whole site, on a subpage, on a single album, and on a journal entry. Unlocking sets an HttpOnly cookie that is valid for 24 hours; nothing is stored server-side.

Three storage formats are accepted:

Format Status
scrypt:salt:hash Recommended. The password is not recoverable from gallery.yaml.
Plaintext Works, but deprecated — logs a warning naming the recommended hash.
bcrypt ($2a$…) Rejected.

To get the hash for an existing plaintext password, unlock the gallery once and read the server log: the successful unlock prints the matching scrypt:… line to paste back into gallery.yaml. Simpler: open the page or album in the admin panel and save it once. Every password saved there is stored as a scrypt:… hash, and the field then reads Protected with Change and Remove instead of showing the stored value.

Note

Album and subpage gates protect the page. Image URLs handed out while a gallery was unlocked keep working — see Image Token Revocation.

Locking the whole site

sitePassword in settings.yaml puts everything public behind one password — useful while a portfolio is still being built, or for a folio that is only ever shown to clients.

# settings.yaml
sitePassword: 'scrypt:...'

SITE_PASSWORD in the environment overrides the file, so the password can be rotated without editing (or backing up) settings.yaml. It accepts the same three storage formats as every other gate.

Unlike the per-page gates, this one is enforced in proxy.ts, before the requested page renders at all. That matters: a gate that merely swapped the page for a login form would still have let the page produce its payload, album names and image tokens included. The public API routes carry the same check themselves, since route handlers do not pass through the proxy.

Three things stay reachable on a locked site:

Path Why
/api/health A health probe runs without cookies; gating it takes the container down.
/admin It has its own password, and it is where sitePassword is set.
/install A fresh deployment has to be configurable before it can be locked.

A locked site also serves noindex, nofollow regardless of the SEO settings — there is nothing there for a crawler.

Photo Order Within an Album

By default a Folio album mirrors the Immich timeline. That is usually right, but a curated series has a narrative order that has nothing to do with capture time — and changing the sort on the Immich album would change it for the archive too. The optional sort key decouples the two.

Mode Order
immich Default. Inherits the album's own asc/desc setting in Immich.
newest Capture time, newest first, regardless of the Immich setting.
oldest Capture time, oldest first.
filename originalFileName in natural order — IMG_2 before IMG_10.
manual Pinned photos first, in the order you set; everything else follows in the Immich order.
albums:
  - 'album-uuid' # no sort key → Immich order, exactly as before
  - 'album-uuid':
      sort: filename # an entry may carry only a sort, with no title override
  - 'album-uuid':
      title: Hokkaido, in sequence
      sort: manual
      assetOrder: # pinned, in this order
        - 'asset-uuid-opening-frame'
        - 'asset-uuid-second-frame'

sort works the same on standalone, subpage and section albums.

About manual

manual is a pinned prefix, not a full permutation: assetOrder lists only the photos you placed by hand, and everything else follows in the album's Immich order. Curating an opening sequence therefore costs a handful of UUIDs rather than one per photo in the album.

This also makes the album resilient to changes in Immich. Photos removed from the album are ignored, and photos added later appear at the end rather than being hidden — so gallery.yaml never has to be kept in sync by hand.

The /admin page builder has a drag & drop editor for this (album → Photo order → Manual → Reorder photos), which is considerably easier than writing asset UUIDs by hand. It only writes a cleaned-up assetOrder when you explicitly apply it.

Note

Two consequences worth knowing. On a subpage with several albums, sort orders photos within each album — the albums themselves stay in the order they are listed in. And lightbox permalinks (#photo-3) are positional, so changing an album's sort moves where a previously shared link lands.

Tip

immich means "inherit the album's sort setting from Immich", which is capture-time order in one direction or the other. It is not the manual drag order from the Immich web UI — Immich does not expose that order through its API, so Folio cannot reproduce it. Use manual for a hand-picked sequence.

Grid Layout

The global default lives in settings.yaml; subpages and individual albums can override it in gallery.yaml. The three levels merge, most specific winning:

global (settings.yaml) → subpage → album

Note

Leaving gap out is not the same as setting 12. Each theme preset picks its own photo spacing (2px minimal, 32px editorial, 40px monograph), and an unset gap lets that stand. Setting one wins in every preset — which is what minimal, editorial and monograph used to ignore (#513).

# settings.yaml — global defaults
grid:
  columns: 3 # number of columns (default: 3)
  gap: 12 # gap in pixels — unset means the theme preset decides
  aspectRatio: '1' # "1", "3/2", "2/3", "16/9", "auto" (default: "1")
  layout: masonry
# gallery.yaml — per-subpage override
subpages:
  - name: Japan
    grid:
      columns: 4
      layout: uniform
      aspectRatio: '3/2'
    albums:
      - '33333333-3333-3333-3333-333333333333'

Available layouts: masonry, uniform, showcase, filmstrip, editorial-flow, justified (experimental), and essay (see Journal & Photo Essays). Each is illustrated in the Theming guide.

Album covers on a subpage

A subpage with more than one album shows a grid of album covers rather than photos. That grid has its own key, coverGrid, which sizes the cover tiles and nothing else. grid next to it stays what it always was: the photos inside those albums.

An unset columns falls back to the site-wide grid.columns, so a page that states nothing tiles its covers the way it tiles its photos. Valid range is 1–6; below 1024px viewport width at most two covers share a row, and below 640px they stack.

gap is the deliberate exception: it does not cascade from the global setting to the covers. Every theme preset picks its own cover spacing as part of its look — 1px in monograph, 2px in minimal and editorial, 20px in studio-modern — and letting the site-wide photo gap through would flatten all of them into one look. Only an explicit coverGrid.gap overrides the preset:

# gallery.yaml — the two grids of one page, set independently
subpages:
  - name: Editorial
    coverGrid:
      columns: 3 # three covers per row (site-wide default otherwise)
      gap: 24 # overrides the theme's own cover spacing
    grid:
      columns: 4 # the photos inside each album
      gap: 6
    albums:
      - '33333333-3333-3333-3333-333333333333'
      - '44444444-4444-4444-4444-444444444444'

Both are editable per page in the admin panel, under Pages › subpage › Album Cover Grid and Photo Grid; left empty they follow the site-wide setting and the theme respectively.

Note

The covers and the photos shared a single grid key until #523, where a gap typed into the admin's cover field turned out to retune every photo grid on the page as well. A gallery.yaml that predates the split has no coverGrid, so the covers fall back to grid and the page renders exactly as before; the first save from the admin panel writes the two out separately.

Site Behaviour

Feature toggles in settings.yaml:

title: 'My Portfolio'
subtitle: 'A visual journal'
lang: 'en'

mode: dark # dark (default) | light | auto — what a first-time visitor sees
exifOnHover: true # the summary overlay on photo grid hover
exif: # which groups may be shown at all
  camera: true # body, lens, focal length
  settings: true # aperture, shutter speed, ISO
  location: true # city and country
  caption: true # the description written in Immich
map: true # the interactive world map at /map
transitions: true # smooth page transitions between routes
scrollToTop: true # floating back-to-top arrow on long pages
analytics: true # cookieless view counts, see below

about:
  enabled: true # the /about page, rendered from content/about.md
Key Default Notes
lang en Interface language, <html lang>, dates
mode dark Visitor's starting colour mode, see below
exifOnHover on The grid hover overlay only, see below
exif.* on Per-group EXIF visibility, see below
map off Opt-in: must be set to true explicitly
transitions on
scrollToTop on
analytics on
about.enabled on Needs a content/about.md to show anything

Colour mode

mode decides what a visitor sees before they touch anything: dark (the default the site has always had), light, or auto to follow their operating system. It is rendered onto <html> server-side, so the first paint is already right rather than flipping after the page loads.

A visitor's own choice from the header toggle is kept in their browser and always wins over this — mode only sets the starting point. The light/dark switch in the admin panel previews your view and does not change what visitors get; that is what this setting is for (#512).

EXIF visibility

exif decides what the site may publish about a photo. It governs all three places the data appears — the grid hover overlay, the lightbox info panel, and the camera line in the album header — so they cannot disagree.

caption is the description written in Immich. It used to be shown regardless of any setting, on the grounds that a caption is editorial rather than metadata — which left it as the one field nobody could switch off, and Immich descriptions are also where people keep private notes and whatever a decade of cataloguing software left behind (#506). It is a group like any other now.

exifOnHover predates the block and stays: it decides whether the grid shows its overlay at all, and it supplies the default for the three technical groups, so an existing exifOnHover: false still means "no technical EXIF anywhere". An explicit exif key always wins over it. Captions never followed that switch and still do not — set caption: false to turn them off.

With every group off, the lightbox withdraws its info button and the i key rather than opening an empty panel.

Interface language

lang picks the language of the visitor-facing interface — navigation, the lightbox, the password gate, the proofing dialog, the legal notice, error pages — and is also emitted as <html lang> and used for date formatting.

Value Interface
en English (default)
de German
fr French
es Spanish
it Italian
nl Dutch

Region subtags are accepted and dropped for the interface (fr-CA → French, nl-BE → Dutch), while the full value still reaches <html lang>.

Any other value (ja, pt, …) still reaches <html lang> and toLocaleDateString, but the interface stays English: there is no dictionary for it yet. That is deliberate — claiming lang="en" on a French site would be worse for screen readers than an English interface on a page correctly marked as Japanese.

Two things stay in one language by design:

  • The admin panel is always English, whatever lang says.
  • /impressum keeps its German headings when lang: de and the § 5 DDG citation in every language, because that is what the statute names (legal.heading replaces it where another law applies). Under lang: en the footer link reads "Legal Notice" rather than "Impressum" — the page is optional (legal.enabled), and an unexplained German word in the footer of an English site is what drove this out of the backlog.

Adding a language means adding one file under lib/i18n/locales/ and listing it in SUPPORTED_LOCALES (lib/i18n/index.ts). The dictionary is typed against the English one, so a missing key fails the type-check rather than falling back silently, and lib/__tests__/i18n.test.ts additionally catches keys that were copied over but never translated. Words a language genuinely shares with English (ISO, Info, French "photos") go into that locale's allowance list in the same test, which in turn fails if an entry stops being identical. Add the language to the Language select in app/admin/components/SettingsEditor.tsx so it can be picked from the admin panel.

Analytics

Page and album view counts, stored in content/analytics.json — no cookies, no third party, nothing leaving your server. The numbers are shown in the admin panel's Analytics tab.

analytics: false # stop counting entirely

With analytics: false the tracking endpoint refuses to record, so no data is collected regardless of what the browser sends.

Experimental. External links appended to the header navigation. Only http(s) URLs are accepted, and they open in a new tab:

navLinks:
  - label: 'Shop'
    url: 'https://shop.example.com'
  - label: 'Instagram'
    url: 'https://instagram.com/your-handle'

Client Proofing

Lets a visitor mark favourites and export the selection — for handing a client a gallery and getting their picks back. A heart button sits on every photo in the grid; once something is picked, a bar appears with a filter and an export dialog.

The selection is encoded into the URL as a compact bitmask and mirrored into localStorage, so nothing is stored server-side and a set of picks can be shared, bookmarked, or sent back as a plain link.

When an album also opts into originals download, the export dialog gains a Download selected (.zip) action, and the album header a Download album link.

Configured in settings.yaml:

proofing:
  enabled: true # hearts, selection bar and export modal (default: true)
  allowMailto: true # offer "send by email" alongside the copyable list (default: true)

A subpage overrides enabled in either direction — useful to keep proofing off across a public portfolio and switch it on for a single client handover:

# gallery.yaml
subpages:
  - name: Wedding – Smith
    password: clientpass123
    proofing: true # or `false` to disable it on this subpage only
    albums:
      - ...

Precedence is subpage → global: a subpage's own proofing: wins, and an album reached without a subpage follows proofing.enabled.

Note

Photo essays are the exception. A published story is not an album handover, so an essay (layout: essay, essayFile, essayText) shows the proofing controls only when its subpage sets proofing: true explicitly — the global default does not reach into essays. Journal entries never show them.

Image Protection & Watermark

protection:
  disableRightClick: true # suppress the context menu on images
  disableImageDrag: true # block drag-to-desktop

watermark:
  enabled: true
  text: '© Your Name'
  opacity: 0.5 # fraction, 0–1: 0.5 is 50%
  position: 'bottom-right' # bottom-right | bottom-left | center

opacity is a fraction between 0 and 1, the same unit the admin slider writes. A value above 1 is read as a percentage (90 means 0.9), so configs written that way before the unit was fixed keep working.

Note

Both are deterrents against casual copying, not protection. The image is in the browser, and anyone who wants it can take a screenshot. The watermark is an overlay on the lightbox, not burned into the file.

SEO

seo:
  title: 'My Portfolio | Photography'
  description: 'A curated selection of my best photography work.'
  titleTemplate: '%s | My Portfolio' # %s is the subpage or album title
  noIndex: false # true → ask search engines not to index the site
  noFollow: false # true → ask search engines not to follow links

titleTemplate shapes the browser and search-result title of every subpage and album; the homepage uses title unchanged.

Optional minimal footer with social links, in settings.yaml:

footer:
  name: John Doe
  instagram: johndoe
  email: hello@example.com
  website: https://example.com

A legal: block with enabled: true adds an Impressum page at /impressum and links it in the footer — see content/settings.yaml.example for every field.

Email, phone and contactUrl render as links. contactUrl is a second contact channel such as a contact form, which case law accepts in place of a phone number; it takes http(s) URLs only and is dropped with a warning otherwise. heading replaces the "Angaben gemäß § 5 DDG" line, e.g. for § 5 ECG in Austria.

A privacy policy is written in the admin panel and stored in content/privacy.md; /privacy shows it and the footer links it once the file has text. privacy: { enabled: false } hides it without deleting the file. See Privacy Policy.

A contact: block with enabled: true adds a contact form at /contact and links it in the footer. Messages stay on the server (content/messages/) and are read in the admin panel; see Messages. While the Impressum has no contactUrl, it links this form as the second contact channel.

contact:
  enabled: true
  notifyUrl: https://ntfy.sh/your-secret-topic # optional push for new messages
  retentionDays: 90 # delete messages after this many days

About Page

Create content/about.md with YAML frontmatter:

---
portrait: asset-uuid-for-your-portrait
name: Your Name
location: City, Country
gear:
  - Camera Body
  - Favorite Lens
---

Your bio text here. Supports full Markdown.

The page is served at /about and linked in the navigation. Turn it off in settings.yaml without deleting the file:

about:
  enabled: false

The admin panel's Settings → About section edits the same file — portrait, name, location, gear list and bio — so about.md does not have to be written by hand.

Journal & Photo Essays

Long-form storytelling with fullbleed photos, side-by-side pairs, quotes and captions lives in content/journal/, served at /journal. A subpage can also be turned into a single photo essay.

→ Journal & Photo Essays

Finding UUIDs

  • Album UUIDs: In Immich, go to Albums → click an album → the UUID is in the URL bar
  • Asset UUIDs: Click any photo → the UUID is in the URL bar

System & Security

Advanced system settings are configured via environment variables in your .env or .env.local file.

Rate Limiting

To protect against brute-force attacks and resource exhaustion, Immich Folio includes an in-memory rate limiter. Each endpoint has its own bucket, so heavy image traffic cannot exhaust the budget for the password endpoints.

  • RATE_LIMIT_RPM: requests per minute per IP for image, video, EXIF and health requests (default: 1500).

The endpoints where a high limit would be the wrong default are fixed and not configurable:

Endpoint Limit (req/min/IP)
POST /api/admin/auth 5
POST /api/auth 10
/api/install 10
/api/og 30
/api/install/albums 30
/api/webhook 60
/api/map 120

Important

The limiter lives in the process memory of a single instance. It does not coordinate across replicas, and it starts empty after a restart.

Trusted Proxies

If you run Immich Folio behind a reverse proxy (nginx, Traefik, Caddy, Cloudflare), tell it how many proxies sit in front. Without this, the rate limiter reads a client-supplied header and an attacker can pick their own bucket — defeating brute-force protection on the password endpoints.

  • TRUSTED_PROXY_HOPS: Number of reverse proxies in front of the app (default: 0).
# nginx / Traefik / Caddy directly in front of the app
TRUSTED_PROXY_HOPS=1

# Cloudflare in front of nginx
TRUSTED_PROXY_HOPS=2

The client IP is taken that many entries from the right of X-Forwarded-For. Proxies append the address they actually observed, so everything to the left is client-supplied and ignored — a visitor sending X-Forwarded-For: 1.1.1.1 cannot influence which bucket they land in.

⚠️ The app must be reachable only through the proxy. Bind it to localhost (127.0.0.1:3000) or keep it on an internal Docker network. If clients can connect directly they control the entire header, and no setting can recover the real IP.

Matching nginx config:

location / {
    proxy_pass http://127.0.0.1:3000;
    proxy_set_header Host              $host;
    proxy_set_header X-Real-IP         $remote_addr;
    proxy_set_header X-Forwarded-For   $proxy_add_x_forwarded_for;
    proxy_set_header X-Forwarded-Proto $scheme;
}

$proxy_add_x_forwarded_for is the important one: it appends the real peer address rather than overwriting the header.

Migrating from TRUSTED_PROXIES

TRUSTED_PROXIES has been removed. It matched proxy IPs against the socket peer address, which a self-hosted Next.js server never exposes — so the check never passed. Setting it silently put every visitor into one shared rate-limit bucket, letting a single client trip the limit for the entire site. If it is still set, the app assumes TRUSTED_PROXY_HOPS=1 and logs a warning; replace it with an explicit value.

Image Token Revocation

Asset tokens are deterministic — the same photo always yields the same token, which is what lets browsers cache images for a year. The image proxy validates the token but does not re-check album membership on every request.

Removing an album from gallery.yaml hides it from the site, but any image URL already handed out (bookmarked, embedded, cached by a browser) keeps working. To invalidate previously issued links, rotate AUTH_SECRET — this also signs out every password-protected gallery and admin session.