filebrowser README

The project's README from github.com/gtsteffaniak/filebrowser. As one markdown file: README.md.

Codacy Badge latest version DockerHub Pulls Apache-2.0 License

Donate

FileBrowser Quantum logo

FileBrowser Quantum

The best free self-hosted web-based file manager.

FileBrowser Quantum file listing in dark mode

Pinned

:pushpin: Read The Official Docs (currently english-only)

:pushpin: v2.0.0 is now stable! --> See migration support discussion

About

FileBrowser Quantum provides an easy way to access and manage your files from the web. It has a modern responsive interface that has many advanced features to manage users, access, sharing, and file preview and editing.

This version is called "Quantum" because it packs tons of advanced features into a tiny and easy-to-run file. Unlike the majority of alternative options, FileBrowser Quantum is simple to install and easy to configure.

The goal for this repo is to become the best open-source self-hosted file browsing application that exists -- all for free. This repo will always be free and open-source.

Ready to try it out? See Getting Started Docs.

How its different

FileBrowser Quantum is a massive fork of the file browser open-source project with the following changes:

  1. ✅ Better source configuration - multiple sources, include/exclude rules, and more
  2. ✅ Login support for OIDC, LDAP, JWT, password + 2FA, and proxy.
  3. ✅ Beautiful, Responsive, and Customizable user interface.
  4. ✅ Streamlined configuration via config.yaml config file.
  5. ✅ Efficient search
    • Real-time search results as you type.
    • Real-time monitoring and updates in the UI.
    • Search supports file and folder sizes, along with various filters.
  6. ✅ Better listing browsing
    • Thumbnails support includes office, video, and album artwork, and 3D models.
    • Faster and more responsive views with animations.
    • Folder sizes are displayed and support thumbnails
    • Navigating remembers the last scroll position.
    • WebDAV support
    • Granular permissions
  7. ✅ Highly configurable and customizable sharing options
    • share expiration time
    • users who can access share (including anonymous)
    • styling and themes
    • file viewing, editing, and uploading permissions
  8. ✅ Access control that can be scoped to user or group and source path.
  9. ✅ Developer API support
    • Ability to create long-lived API Tokens.
    • A helpful Swagger page is available at /swagger endpoint for API enabled users.

Notable features that this fork does not have (removed):

FileBrowser Quantum differs significantly from the original version. Many of these changes required a significant overhaul. Creating a fork was a necessary process to make the program better. There have been many growing pains, but a stable release is planned and coming soon.

The UI

The UI has a simple three-component navigation system:

  1. (Left) Multi-action button with slide-out panel.
  2. (Middle) The powerful search bar / title
  3. (Right) The view change toggle / overflow menu

All other functions are moved either into the action menu or pop-up menus. If the action does not depend on context, it will exist in the slide-out action panel. If the action is available based on context, it will show up as a pop-up menu.

Aug-07-2026 14-54-55

Official Docs

See the Official Docs. Contributions are welcome and encouraged! See FilebrowserDocs Github.

Comparison Chart

Application Name Quantum Filebrowser Filestash Nextcloud Google_Drive FileRun
Filesystem support ✅ ✅ ✅ ✅ ❌ ✅
Linux ✅ ✅ ✅ ✅ ❌ ✅
Windows ✅ ✅ ✅ ❌ ❌ ✅
Mac ✅ ✅ ✅ ❌ ❌ ✅
Self hostable ✅ ✅ ✅ ✅ ❌ ✅
Has Stable Release? ✅ ✅ ✅ ✅ ✅ ✅
S3 support ❌ ❌ ✅ ✅ ❌ ❌
webdav support ✅ ❌ ✅ ✅ ❌ ✅
FTP support ❌ ❌ ✅ ✅ ❌ ✅
Dedicated docs site? ✅ ✅ ✅ ✅ ✅ ✅
Multiple sources at once ✅ ❌ ✅ ✅ ❌ ✅
Docker image size 180 MB (with ffmpeg) 31 MB 240 MB (main image) 250 MB ❌ > 2 GB
Min. Memory Requirements 512 MB 128 MB 128 MB (main image) 512 MB ❌ 512 MB
has standalone binary ✅ ✅ ✅ ❌ ❌ ❌
price free free free free tier free tier $99+
rich media preview ✅ ✅ ✅ ✅ ✅ ✅
Upload files from the web? ✅ ✅ ✅ ✅ ✅ ✅
Advanced Search? ✅ ❌ ✅ configurable ✅ ✅
Indexed Search? ✅ ❌ ✅ configurable ✅ ✅
Content-aware search? ❌ ❌ ✅ configurable ✅ ✅
Custom job support :construction: ✅ ✅ ✅ ❌ ✅
Multiple users ✅ ✅ ✅ ✅ ✅ ✅
Single sign-on support ✅ ❌ ✅ ✅ ✅ ✅
LDAP sign-on support ✅ ❌ ✅ ✅ ✅ ✅
Long-live API key support ✅ ❌ ✅ ✅ ✅ ✅
API documentation page ✅ ❌ ✅ ✅ ✅ ✅
Mobile App ❌ ❌ ❌ ✅ ✅ ❌
open source? ✅ ✅ ✅ ✅ ❌ ❌
tags support :construction: ❌ ✅ ✅ ❌ ✅
shareable web links? ✅ ✅ ✅ ✅ ✅ ✅
Event-based notifications :construction: ❌ ✅ ❌ ❌ ✅
Metrics :construction: ❌ ✅ ✅ ❌ ❌
file space quotas ✅ ❌ ✅ ❌ ✅ ✅
text-based files editor ✅ ✅ ✅ ✅ ✅ ✅
Office file support ✅ ❌ ✅ ✅ ✅ ✅
Office file previews ✅ ❌ ❌ ✅ ✅ ✅
Themes ✅ ✅ ✅ ✅ ❌ ✅
Branding support ✅ ✅ ✅ ❌ ❌ ✅
activity log ✅ ❌ ✅ ✅ ✅ ✅
Comments support ❌ ❌ ✅ ✅ ✅ ✅
trash support :construction: ❌ ✅ ✅ ✅ ✅
Starred/pinned files ✅ ❌ ✅ ✅ ✅ ✅
Chromecast support ❌ ❌ ✅ ❌ ❌ ❌
Share collections of files :construction: ❌ ❌ ❌ ❌ ✅
Can archive selected files ✅ ❌ ❌ ❌ ❌ ✅
Can browse archive files :construction: ❌ ✅ ❌ ❌ ✅
Can convert documents :construction: ❌ ✅ ❌ ❌ ✅
Can convert videos :construction: ❌ ✅ ❌ ❌ ❌
Can convert photos :construction: ❌ ✅ ❌ ❌ ❌

filebrowser (gtsteffaniak/filebrowser)

Searching Database…

这是什么?FileBrowser Quantum 是一个可以自己搭建的网络应用,让你通过浏览器来浏览、管理、预览和编辑文件,界面现代,还能自适应手机和电脑屏幕。
这是桌面软件,还是需要我自己搭建的服务?它是需要自己搭建的网页版文件管理器,运行在你自己的服务器或电脑上,不是桌面软件。
怎么把它跑起来?下载独立的二进制文件或者使用 Docker 镜像,通过 config.yaml 进行配置,然后通过网页界面访问。完整步骤见官方入门文档(Getting Started Docs)。
必须用 Docker 吗,有没有独立的可执行文件?两种都可以:它提供独立的二进制文件,也提供 Docker 镜像(约 180 MB,内置了 ffmpeg,用于生成媒体缩略图),大约需要 512 MB 内存。
对比表里列的功能都做完了吗?有几个宣传的功能(自定义任务、标签、事件通知、指标统计、回收站、压缩包浏览/转换、文档/视频转换)仍标注为开发中,还没完全上线。另外它不支持 S3 和 FTP,也没有手机应用。
它能在 Windows 和 Mac 上运行吗,还是只支持 Linux?可以,对比表确认它支持 Linux、Windows 和 Mac 的文件系统。
和原版 FileBrowser 项目相比,少了什么?出于安全考虑,这个分支版本完全去掉了执行 Shell 命令的功能;其余部分都是在原版基础上的扩展。
用户怎么登录?它支持 OIDC、LDAP、JWT、带可选两步验证(2FA)的标准密码登录,以及基于代理的认证方式,还可以按用户、用户组或来源路径设置精细的访问权限。
它能预览视频和 3D 模型吗?可以,缩略图功能覆盖办公文档、视频、专辑封面和 3D 模型,文件列表的展示也更快,还带动画效果。
为什么叫 "Quantum"?这个名字表示:和同类产品相比,它把很多高级功能装进了一个非常小巧、容易运行的二进制文件里。
Size
99.6 MB
Stars
8.8K
Age
3y
Commits · 90 Days