Work Intent: File Manager

[biby-best]

Overview

I want to work on integrating a modern file management API into Unraid by leveraging an existing, mature file management service (FileBrowser). The current system lacks a performant, API-driven file manager that can power modern web interfaces, mobile apps, and automation tools. By integrating FileBrowser as a sidecar service into the Unraid API, we avoid reinventing the wheel and provide users with a robust, extensible, and secure solution.

Technical Approach

I intend to use the sidecar mechanism as stated in the original issue #1599.
The approach includes:

• Running FileBrowser as a subprocess (sidecar) managed by the Unraid API lifecycle.
• Proxying API requests and WebSocket connections through NestJS, enforcing Unraid authentication via headers (X-Unraid-User, X-Unraid-Roles).
• Disabling FileBrowser’s built-in authentication and bridging Unraid session cookies/tokens to handle user identity and permissions.
• Bundling the FileBrowser binary into the Unraid plugin build process (build-txz.ts) so it is always available on installation.
• Creating a WebGUI integration following the LogViewer.vue pattern with iframe embedding, so users can access the File Manager directly from the Tools menu.
• Adding documentation and tests to ensure reliability, performance, and security.

Scope

• API
• Plugin
• Web UI
• Build/Deploy Process
• Documentation

Timeline & Impact

• Estimated time needed: ~2–3 weeks (including development, integration, and testing).
• Potential impacts:

Pre-submission Checklist

• I have searched for similar work/issues
• I understand this needs approval before starting
• I am willing to make adjustments based on feedback

[elibosley]

Thank you for this. We'll get back to you (hopefully tomorrow) with more information on the feature bounty process.

[elibosley]

Hi there, the feature bounties are now live. Did you want to read over the policies, etc. here :

https://unraid.net/blog/api-feature-bounty-program

as well as ensure you're comfortable working on this? Otherwise I'm happy to approve this work.

[biby-best]

Hi @elibosley
I have read them and will start this weekend

[elibosley]

Awesome. Keep me updated and feel free to use this thread to ask questions.

[elibosley]

How are things @biby-best

[biby-best]

I'm looking at finishing this weekend @elibosley
But I'll drop updates here
Thanks for the patience

[biby-best]

I'll be sending a demo video today
And a draft PR

[elibosley]

Hi! Any updates :)

[biby-best]

I have been able to setup the filebrowser as a sidecar but have some issues with the authentication
https://streamable.com/e/t94wsn
For some reason I can't send the video on github directly

[elibosley]

This is an awesome start! Are you running this with the nest server? Just wondering as on Unraid OS we'll need the filebrowser service to run outside of the docker context likely if possible.

Wondering about making this more integrated next to allow it to be more of a component of the OS - as part of this we need to ensure this file manager can be easily used from within Unraid (probably just an iframe would be enough), but utilize Cookie based auth or the built into Unraid authentication system to prevent users needing to sign in with a separate account on this service.