dsh-inline-media-viewer-plugin

🚀 Quick install

dsh plugin --profile web add @wisdoverse/dsh-inline-media-viewer@1.0.14

Restart the Web profile after installation. See compatibility and installation details.

🚀 Installation · ✨ Features · ⚙️ Configuration · 🐛 Feedback

Contents

• Features
• Supported media
• Installation
• Configuration
• Security
• Development
• License

https://…/view?filename=frame.png  →  <img>
exports/demo.mp4                   →  <video controls>
audio/sound.mp3                    →  <audio controls>

Features

Icon	Feature	Description
🖼️	Inline rendering	Displays images, videos, and audio directly below the chat turn that mentions them.
📁	Workspace-safe reads	Resolves local paths with realpath and rejects traversal, out-of-workspace paths, and symlink escapes.
🔌	Optional ComfyUI proxy	Fetches recognized ComfyUI media URLs server-side from the configured origin, including for remote users and HTTPS pages.
📏	Bounded transfers	Limits each file or response to 48 MiB and remote requests to 20 seconds.
⚙️	User controls	Provides auto-render, per-turn item limit, media height, and optional ComfyUI origin settings.

[!NOTE] ComfyUI is not required. Workspace files and regular HTTP(S) media URLs work when ComfyUI is not installed or running; its proxy is activated only for recognized ComfyUI URLs.

Supported media

Type	Extensions
Images	png, jpg, jpeg, webp, gif, avif, bmp, svg
Video	mp4, webm, mov, m4v, mkv, avi, ogv
Audio	mp3, wav, m4a, aac, ogg, oga, flac, opus

The browser must support the media codec to play its file.

Installation

Version 1.0.14 extends support through DSH v0.2.1-rc.5. On rc.5, Firefox checks pass for PNG previews, image enlargement, WAV and MP4 playback, reload restoration, and settings display. Host tests and live API checks also pass. ComfyUI and settings writes remain untested on rc.5.

Version 1.0.13 supports DSH v0.2.1-rc.2 (latest) and v0.2.1-rc.3 (next). We checked these npm tags on 2026-10-26. See the DSH v0.2.1-rc.3 release.

On v0.2.1-rc.2 and v0.2.1-rc.3, all 28 Web and API checks passed in Microsoft Edge for each version. PNG and SVG images displayed. MP4 and WebM videos played, and WAV audio played. These checks covered workspace files, direct HTTP URLs, and the ComfyUI proxy. A local HTTP fixture supplied ComfyUI responses. We did not run ComfyUI generation workflows.

Settings persistence, reset, display limits, auto-render, image enlargement, and Escape dismissal passed. Previews refresh when the ComfyUI origin changes, including transitions between proxy reads and direct URLs. Local reads follow the session's current working directory, including stored directory changes. The host rejected unauthenticated reads, paths outside the workspace, redirects, oversized responses, and non-media responses. Host checks also cover stored sessions, symlink escapes, directories, oversized files, and the header fallback for earlier DSH versions.

Version 1.0.13 includes the v0.2.1 compatibility changes and media fixes. It also keeps the v1.0.12 fix for the obsolete settingsScope dependency.

From npm

Install and activate the bundle in your Web profile:

dsh plugin --profile web add @wisdoverse/dsh-inline-media-viewer@1.0.14

Restart the Web profile after installation.

From source

1. Clone the plugin into a location available to your Web profile:

   git clone https://github.com/Wisdoverse/dsh-inline-media-viewer-plugin.git \
     /path/to/local-plugins/dsh-inline-media-viewer
   

2. Add the bundle to profiles/web/package.json:

   {
     "dependencies": {
       "@wisdoverse/dsh-inline-media-viewer": "link:/path/to/local-plugins/dsh-inline-media-viewer"
     },
     "dsh": {
       "profile": {
         "bundles": ["…", "@wisdoverse/dsh-inline-media-viewer"]
       }
     }
   }
   

3. Rebuild or restart the Web profile.

The plugin mounts its host API routes, client projection, and settings section through cordis.patch.yml.

Configuration

Open Settings → 媒体预览 / Media preview.

The navigation label and all setting copy follow DSH's active UI language and switch live between English and Chinese.

Setting	Default	Allowed values
Auto-render detected media	On	On / off
Maximum items per turn	12	1–30
Maximum media height	380 px	160–1200 px
ComfyUI origin (optional)	Empty	http(s)://host[:port]

Settings are stored in the active DSH profile configuration. DSH imports the previous inline-media section from settings.yaml when upgrading. Writes are available only on loopback connections; remote browsers can read these four settings through the plugin's authenticated RPC channel but cannot change them.

ComfyUI origin

• Skip this setting entirely if you do not use ComfyUI.
• Leave the field empty to use http://127.0.0.1:8188.
• Accepted forms are http://host[:port], https://host[:port], and bare host[:port] (http is assumed).
• The default port is 8188 for HTTP and 443 for HTTPS.
• Credentials, paths, query strings, and fragments are rejected.
• The origin must be reachable from the DSH host process. For a containerized host, use the address visible from inside the container.

Local aliases (127.0.0.1:8188 and localhost:8188) and the configured origin are recognized as ComfyUI sources. A non-empty invalid address fails explicitly instead of silently falling back to another target.

Security

The plugin is designed as a local trust helper, not a general-purpose file or network proxy:

• Local reads are confined to the active session's workspace and known media extensions.
• Remote reads can target only the configured ComfyUI origin; redirects are refused.
• Local files and remote responses are capped at 48 MiB.
• Settings writes are restricted to loopback connections.
• The browser receives media as data: URLs rather than filesystem paths.

See SECURITY.md for the complete trust model and known limitations.

Development

Commands

Command	Purpose
node test.mjs	Run the dependency-free unit tests directly.
node test.mjs --host	Run the host registration check after installing peer dependencies.
npm test	Run the same unit test suite through npm.
npm run lint	Syntax-check the host modules and test file.

Project structure

Path	Responsibility
index.js	Host API routes, ComfyUI proxy, and settings registration.
lib.js	Dependency-free helpers, including session directory resolution.
client/client.js	Turn projection, media renderer, and settings UI.
cordis.patch.yml	Bundle mounting and integration points.
test.mjs	Helper and client checks, plus optional host checks.

The running Web profile serves a bundled copy. Rebuild or restart it after changing the source files.

License

Released under the MIT License.