Files

4.8 KiB

Install

  • Clone repo
  • Visit chrome://extensions
  • Enable Developer Mode on the top right
  • Click Load unpacked
  • Select the cloned folder

Settings

Right-click on the installed extension icon at the top right -> Options

API Endpoint: http://127.0.0.1:8080/run (IP:Port of the router-api container)

API Token: REPLACE

User: REPLACE (also available to dynamic profile values as {{user}})

Editable Fields: immich.albums;jellyfin.backdrop_length

Downloader Profiles:

{
  "local": {
    "post_processor": "local",
    "yt_dlp_args": "",
    "gallery_dl_args": "",
    "local": {
      "destination_dir": "/path/to/local/dir",
      "reencode": true
    }
  },
  "immich": {
    "post_processor": "immich",
    "yt_dlp_args": "",
    "gallery_dl_args": "",
    "immich": {
      "server": "https://127.0.0.1:2283",
      "api_key": "REPLACE",
      "albums": "#Misc - Quarantine >> Automated Uploads"
    }
  },
  "immich-or-jellyfin": {
    "post_processor": "length-based-routing",
    "yt_dlp_args": "",
    "gallery_dl_args": "",
    "immich": {
      "server": "http://127.0.0.1:2283",
      "api_key": "REPLACE",
      "albums": "#Misc - Quarantine >> Automated Uploads"
    },
    "jellyfin": {
      "library_path": "/path/to/jellyfin/library",
      "backdrop_length": 10
    },
    "length_routes": [
      { "min": 0, "max": 180, "script": "immich" },
      { "min": 180, "script": "jellyfin" }
    ]
  }
}

You can override the yt-dlp archive file per profile by adding a custom argument string. The downloader wrapper supports a dedicated archive override flag, so the following examples are ready to paste into a profile's yt_dlp_args field.

Profile strings support dynamic values resolved by the router at job creation time. This keeps existing static profiles compatible while allowing per-job album names and paths. Use {{user}} (also available as {{username}}) for the configured extension user, and URL/job values such as {{url.hostname}}, {{url.path}}, {{name}}, {{format}}, and {{downloader}}.

For example, an Immich profile can keep manually defined albums and add a user-specific album using the existing >> album separator:

"albums": "#Misc - Quarantine >> People - {{user}}"

The router resolves these placeholders before dispatching the job to the downloader, so no Immich post-processor change is required. Unknown placeholders are preserved so future variables do not silently corrupt existing profiles.

"yt_dlp_args": "-a /data/archive/yt-dlp-archive.txt"
"yt_dlp_args": "-a archive/immich-archive.txt"
"yt_dlp_args": "-a /tmp/yt-dlp-archive.txt"

If you want to keep the default archive behavior, leave yt_dlp_args empty. If you want to disable archive tracking entirely, use -A instead.


Download

  • Open extension
  • Switch to the Dashboard tab to view and control workers without leaving the side panel
  • Select profile
  • (Optional) Enable Downloader Options -> Skip yt-dlp archive check (-A) to force archive bypass for this panel session
  • Keyboard shortcuts:
    • Ctrl+Shift+Y (Command+Shift+Y on macOS): Add current page URL to panel
    • Ctrl+Shift+U (Command+Shift+U on macOS): Add hovered image/video URL to panel (best effort)
    • Rebind keys at chrome://extensions/shortcuts
  • Right click on eg a image or video -> Add image URL to portal
  • Send URLs to API

The dashboard tab uses your configured API Endpoint as base URL and opens /dashboard automatically.

API submission contract

When Send URLs to API is used, the extension sends POST /run with the following API fields only:

{
  "url": "https://example.com/media",
  "name": "optional filename",
  "priority": 200,
  "status": "active",
  "format": "mp4",
  "downloader": "yt-dlp",
  "user": "optional user",
  "invoked_from": "browser-extension-panel",
  "client": { "app": "downloader-pipeline-portal", "surface": "sidepanel" },
  "profile": {}
}

sourceTabId and created are extension-local queue metadata. They are used for browser tab handling and local ordering, but are intentionally not sent to the API because /run rejects unknown top-level fields. Empty optional fields are omitted, and priority is sent as an integer only when it is valid.

Browser delivery

To have the extension automatically download the completed file, add this to the selected profile:

"browser_delivery": {
  "enabled": true,
  "playlist": "separate"
}

Use "playlist": "zip" when a playlist should arrive as one ZIP archive. The extension tracks these jobs in its service worker and starts the browser's native download when the API reports completion. No file bytes are buffered in the side panel. Browser delivery can be used alone or alongside an existing Immich, Jellyfin, or local profile.