← Back to Whimbrel for Darktable

Whimbrel for Darktable — Setup & Options

Whimbrel adds Immich as a target in Darktable's export panel. Pick it, export, and your edits upload to your self-hosted Immich in one go — no export-to-folder-then-upload dance. A small menu-bar app holds your server settings and installs the Darktable plugin for you.

Requirements

  • macOS 13 Ventura or later
  • Darktable for Mac
  • A self-hosted Immich server, reachable from your Mac
  • An Immich API key (see below)

Get an Immich API key

  1. In Immich, open Account Settings → API Keys → New API Key.
  2. Darktable only uploads, so the asset.upload permission is enough (a full-access key also works).
  3. Copy the key.

Set it up

  1. Download and open Whimbrel for Darktable (drag it to /Applications first).
  2. Open the window from the menu-bar icon, go to Settings, and under Immich Connection paste your Server URL and API key.
  3. Click Test Connection to confirm it reaches your server.
  4. Click Install to install the Darktable plugin.
  5. Click Save, then restart Darktable so it loads the plugin.

Using it

In Darktable's export panel (lighttable view, right-hand side), choose Immich as the storage / target, then export as usual. Your edits are rendered and uploaded straight to Immich. Watch progress from the menu-bar icon.

Re-exporting the same photo is safe — Immich de-duplicates by checksum.

Options reference

SectionOptionWhat it does
Immich ConnectionServer URLYour Immich address. https:// anywhere; plain http:// only on a local network (LAN/localhost).
Immich ConnectionAPI keyStored in your macOS Keychain, never sent anywhere but your server.
Immich ConnectionTest ConnectionChecks the URL + key reach your Immich.
PluginInstallInstalls the Immich storage plugin into Darktable. Restart Darktable afterwards.
PluginRemoveDeletes the installed plugin (you can reinstall anytime).
VisibilityShow in DockShow a Dock icon.
VisibilityShow in Menu BarShow the menu-bar icon. If you turn both off, the menu-bar icon comes back on next launch so the app stays reachable.
(footer)SaveSaves your settings. The window stays open.

Notes

  • The plugin reads the settings you saved in the app — if you change your URL or key, click Save (no need to reinstall the plugin).
  • Local networks: plain http:// is allowed for localhost and private ranges (192.168.x, 10.x, 172.16–31.x). Everything else must be https://.
  • Recent uploads are listed in the menu-bar popover.
  • Updates are included; the app is signed and notarized by Apple.

Ready to send your edits to Immich?