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…

8.8K ·GitHub
Filebrowser
Что это такое?FileBrowser Quantum — это self-hosted веб-приложение, которое позволяет просматривать, управлять, смотреть предпросмотр и редактировать свои файлы прямо в браузере, с современным адаптивным интерфейсом.
Это десктопное приложение или что-то, что я размещаю у себя?Это self-hosted файловый менеджер на основе веб-интерфейса, который вы запускаете на своём сервере или компьютере, а не десктопное приложение.
Как его запустить?Скачайте standalone-бинарник или используйте Docker-образ, настройте его через config.yaml, затем откройте доступ через веб-интерфейс. Все шаги подробно описаны в официальной документации Getting Started.
Мне нужен Docker, или есть standalone-бинарник?Подойдёт любой вариант: он поставляется в виде standalone-бинарника или Docker-образа (около 180 МБ, со встроенным ffmpeg для превью медиафайлов) и требует примерно 512 МБ оперативной памяти.
Все ли функции из сравнительной таблицы уже готовы?Несколько заявленных функций (кастомные задачи, теги, уведомления о событиях, метрики, корзина, просмотр/конвертация архивов, конвертация документов и видео) до сих пор помечены как находящиеся в разработке и ещё не полностью выпущены. Также нет поддержки S3 или FTP и нет мобильного приложения.
Он работает на Windows и Mac, а не только на Linux?Да, согласно сравнительной таблице, он поддерживает файловые системы Linux, Windows и Mac.
Чего не хватает по сравнению с оригинальным проектом FileBrowser?Выполнение shell-команд полностью удалено из этого форка из соображений безопасности; всё остальное — это расширение оригинала.
Как пользователи могут войти в систему?Поддерживаются OIDC, LDAP, JWT, стандартный вход по паролю с опциональной двухфакторной аутентификацией, а также аутентификация через прокси, плюс детальный контроль доступа на уровне пользователей, групп или исходных путей.
Есть ли предпросмотр видео и 3D-моделей?Да, предпросмотр охватывает офисные документы, видео, обложки альбомов и 3D-модели, с более быстрыми анимированными списками файлов.
Почему он называется 'Quantum'?Название отражает то, что в очень маленьком и простом в запуске бинарнике упаковано множество продвинутых функций по сравнению с типичными альтернативами.
What are similar projects?zitadel, stalwart, gin-vue-admin, kratos, authelia, NodePilot, casdoor, sftpgo
Which topics is it in?swagger, ldap, access-control, webdav, 2fa, oidc, file-manager, file-sharing, sso, rbac, search, authentication
Creator
gtsteffaniak
Size
100 MB
Stars
8.8K
Updated
CommitOct 13Releasev2.0.1-stableOct 13
Age
3y
Commits · 90 Days