Files
immich-magic-proxy/docs/visitor-uploads.md
T
Alan Grainger 20c4238b6e Update docs
2026-10-06 15:17:11 +13:00

9.4 KiB

Let visitors send photos back

Visitors to a share can send their own photos and videos into it, for example guests adding their pictures to a wedding album. The photos go straight into the album in Immich and appear in the gallery for everyone.

Uploads are handled by a second, optional container, immich-public-proxy-upload. The IPP container stays read-only: its only part in this is an Add photos button that links to the upload service. Immich decides which shares accept uploads, through the "Allow public user to upload" option on each shared link.

This guide assumes IPP is already installed behind a reverse proxy.

Contents

What you need

  • IPP 4.0 or newer and Immich 3.0.0 or newer.
  • A public route to the upload service: its own hostname, such as upload.example.com, or a path on the IPP hostname, such as photos.example.com/upload. If a tunnel points straight at IPP with no reverse proxy, add a second hostname to the tunnel for the upload container.

Add the upload service

Add the service to the docker-compose.yml that runs IPP:

services:
  immich-public-proxy:
    # ... your existing IPP service ...

  ipp-upload:
    image: alangrainger/immich-public-proxy-upload:latest
    container_name: ipp-upload
    restart: always
    ports:
      - "3001:3000"
    environment:
      IMMICH_URL: http://your-internal-immich-server:2283
      PUBLIC_BASE_URL: https://upload.example.com
      GALLERY_URL: https://photos.example.com
    healthcheck:
      test: curl -s http://localhost:3000/healthcheck -o /dev/null || exit 1
      start_period: 10s
      timeout: 5s
  • IMMICH_URL is the same local Immich address that IPP uses.
  • PUBLIC_BASE_URL is the public URL of the upload service. For a path on the IPP hostname, include the path: https://photos.example.com/upload.
  • GALLERY_URL is the public URL of IPP. It gives the upload page a back button to the gallery.

Start it with docker-compose up -d. The full list of settings is on Upload service.

Route it through your reverse proxy

Choose one of the two shapes. The examples reach the container as ipp-upload:3000, which works when the proxy shares a Docker network with it. From the host, use the published port instead: localhost:3001 with the compose file above.

Own hostname

Send everything on the upload hostname to the upload service.

Caddy:

upload.example.com {
    reverse_proxy ipp-upload:3000
}

nginx:

server {
    listen 443 ssl;
    server_name upload.example.com;

    client_max_body_size 500m;
    proxy_request_buffering off;

    location / {
        proxy_pass http://ipp-upload:3000;
    }
}

Path on the IPP hostname

Set PUBLIC_BASE_URL to the URL with its path, for example https://photos.example.com/upload. Forward that path to the upload service with the path left in place, and everything else to IPP.

Caddy (handle keeps the path; handle_path would strip it):

photos.example.com {
    handle /upload/* {
        reverse_proxy ipp-upload:3000
    }
    handle {
        reverse_proxy immich-public-proxy:3000
    }
}

nginx:

server {
    listen 443 ssl;
    server_name photos.example.com;

    location /upload/ {
        client_max_body_size 500m;
        proxy_request_buffering off;
        proxy_pass http://ipp-upload:3000;
    }

    location / {
        proxy_pass http://immich-public-proxy:3000;
    }
}

Check the route by opening /healthcheck on the upload URL: https://upload.example.com/healthcheck or https://photos.example.com/upload/healthcheck. It answers ok when the upload service can reach Immich, and a 503 when it cannot.

Show the button in IPP

Set uploadUrl in IPP's config to the upload service's PUBLIC_BASE_URL:

{
  "ipp": {
    "uploadUrl": "https://upload.example.com"
  }
}

Restart IPP. One config.json can serve both containers: IPP ignores the ipp.upload.* keys, and the upload service reads only those and two shared options.

Turn on uploads for a share

In Immich, turn on Allow public user to upload for the shared link. The option is in the dialog that creates a link, and later under Sharing, Shared links, when you edit the link. The gallery for that share then shows an Add photos button in its header. A share with the option off shows no button, and the upload service refuses it.

Where uploads go:

  • An album share: into the album.
  • A share of selected photos: into the shared link itself, so they show in the same gallery.

Uploaded files belong to the Immich user who owns the share and count against that user's storage. The owner sees them in Immich at once and can remove them there.

A password-protected share asks for its password again on the upload page. The upload service keeps its own unlock, separate from IPP's, and the password never passes between the two.

Note

A share with one photo opens as the image file itself, so there is no header and no button. Set gallery.singleImage to true to show a gallery page instead, or give visitors the upload page's own link: the share's path on the upload URL, such as https://upload.example.com/share/<key>.

Set a storage quota

By default an Immich user has unlimited storage. Set a quota on the user who owns the shares that accept uploads, so visitors cannot fill the disk: in Immich go to Administration, User Management, edit the user and set Quota Size (GiB). Immich refuses uploads past the quota, whatever IPP's own limits allow.

The upload service also caps each share at 10 GB per hour by default. See upload.byteBudget.

Request size limits

The upload service accepts files up to 500 MB by default (upload.maxFileSize), but anything in front of it can impose a lower limit. A file over that limit fails with "Too large for this server".

  • Caddy and Traefik set no request size limit by default.
  • nginx allows 1 MB by default. Set client_max_body_size to at least maxFileSize, and proxy_request_buffering off so nginx streams each file through instead of storing it first. Both are in the examples above.
  • Cloudflare refuses requests over 100 MB on the Free and Pro plans, Cloudflare Tunnel included, so larger videos cannot pass through it. Set maxFileSize to 100 so the page tells visitors before the upload starts:
{
  "ipp": {
    "upload": {
      "maxFileSize": 100
    }
  }
}

Tag uploaded photos

Every uploaded file is stored with ipp_upload_ at the start of its name (upload.filenamePrefix). An Immich workflow can match the prefix to tag uploads, or to copy them into a second album. In Immich, open Workflows and create a workflow with:

  1. Trigger: Asset Upload.
  2. Filter: Filter by filename, match type startsWith, pattern ipp_upload_.
  3. Action: Add Tags with a tag such as Sent by visitors, or Add to Album(s).

Get a notification for each upload

Set upload.notifyUrl to a URL that receives a JSON message for each stored file. Gotify needs nothing more; ntfy needs the template parameters shown on the reference page.

Questions

When do uploads appear

The owner sees them in Immich at once. Other visitors see them in the gallery once three things have happened:

  1. Immich has made the thumbnail. That takes seconds for a photo and longer for a video, and IPP hides a photo until then.
  2. IPP's cache of the share has expired. It is kept for up to 2 minutes.
  3. The visitor's browser has fetched the gallery page again. It keeps the page for 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.

What happens when a visitor sends a photo the owner already has

Immich keeps the one copy and adds it to the share. The visitor's list shows the file as a duplicate.

Can visitors see who uploaded what, or remove photos

No. The upload page shows nothing from the share, only the visitor's own uploads in progress, and nothing can be deleted or edited from it. The owner manages uploads in Immich.

Why does the rate limit count all visitors together

Behind a reverse proxy every visitor reaches the upload service from the proxy's address, so upload.rateLimit applies to all visitors of a share together. To limit each visitor separately, set a rate limit in your reverse proxy.

How do I turn uploads off

For one share, turn off Allow public user to upload in Immich. Immich refuses new uploads at once, and the button leaves the gallery on the same cache times as a new photo takes to appear. For all shares, remove uploadUrl from IPP's config and stop the upload container.