Skip to main content
Version: 2.6.0

Immich Shared Links

You can display images from an Immich shared album directly in Gallery View. This is the Immich shared-link MVP and does not require full authenticated Immich account integration. The link must be a valid, public share link generated by an Immich instance.

Note: The immich-share source type is entirely separate from the authenticated immich source type. It does not use or require any connection keys or API tokens configured in the plugin settings.

Usage​

Add an immich-share source type to your gallery configuration and provide the share URL. This example is the Landscapes album on the public, read-only demo server, so you can paste it into a note as it is:

```obs-gallery
sources:
  - type: immich-share
    url: https://demo-immich.mkshp.dev/share/7XBAej6IyThZOS7izb78XcEJX7QhYwQBmxtHxaBz7TaaqiP5pxWyZQrN6TIvUGRhI9g
view:
  type: justified
```

The justified view shows the photos in even rows, like Immich's own web page for the share. Use masonry for Pinterest-style columns, or any other view.

If your Immich shared link is protected by a password, you can specify the password using the optional password field. The demo server's Travel album is shared with the password gallery-demo:

```obs-gallery
sources:
  - type: immich-share
    url: https://demo-immich.mkshp.dev/share/RAHL6jLQTkqIDaSYjdlHdcbJ4W25u002dyorCdqYVDmoar8xyB7wiE8GARi4QH2eqWw
    password: "gallery-demo"
view:
  type: masonry
```

Features​

  • Works seamlessly with all gallery views (thumbnail, masonry, justified, carousel, embed).
  • Supports the existing modal/lightbox behavior.
  • Can be mixed with other source types (local, external).

Mixed Sources Example​

```obs-gallery
sources:
  - type: local
    path: Images/My Vacation
  - type: immich-share
    url: https://demo-immich.mkshp.dev/share/7XBAej6IyThZOS7izb78XcEJX7QhYwQBmxtHxaBz7TaaqiP5pxWyZQrN6TIvUGRhI9g
view:
  type: thumbnail
```

Troubleshooting​

  • Invalid URL: Make sure the URL points to a valid Immich share link (typically containing /share/).
  • Password Required / 401 Unauthorized: If the shared album requires a password and you haven't provided it, or if the password provided is incorrect, you will see a password authentication failure error. Make sure to specify the correct password in the password field of your source configuration.
  • Share not found: The share may have been deleted, expired, or you might not have network access to the Immich server.
  • Empty share: If the album is empty, the gallery will render normally but without any images.