filebrowser/README.md

FileBrowser Quantum - A modern web-based file manager

[!WARNING] There is no stable version -- planned 2025.

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

1. ✅ Indexes files efficiently. (See indexing Wiki for more info.)
   • Real-time search results as you type
   • Search supports file/folder sizes and many file type filters.
   • Enhanced interactive results that show file/folder sizes.
2. ✅ Revamped and simplified GUI navbar and sidebar menu.
   • Additional compact view mode as well as refreshed view mode styles.
   • Many graphical and user experience improvements.
   • right-click context menu
3. ✅ Revamped and simplified configuration via config.yaml config file.
4. ✅ Better listing browsing
   • Instantly Switches view modes and sort order without reloading data.
   • Folder sizes are displayed
   • Navigating remembers the scroll position, navigating back keeps the last scroll position.
5. ✅ Developer API support
   • Ability to create long-live API Tokens.
   • Helpful Swagger page available at /swagger endpoint.

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

• ❌ jobs/runners are not supported yet (planned).
• ❌ per-user rules are not supported yet (planned).
• ❌ pagination for directory items for extremely large directories.
• ❌ shell commands are completely removed and will not be returned.
• see feature matrix below for more.

About

FileBrowser Quantum provides a file-managing interface within a specified directory and can be used to upload, delete, preview, rename, and edit your files. It allows the creation of multiple users and each user can have its directory.

This repository is a fork of the original filebrowser with a collection of changes that make this program work better in terms of aesthetics and performance. Improved search, simplified UI (without removing features) and more secure and up-to-date build are just a few examples.

FileBrowser Quantum differs significantly from the original. There are hundreds of thousands of lines changed and they are generally no longer compatible with each other. This has been intentional -- the focus of this fork is on a few key principles:

• Simplicity and improved user experience
• Improving performance and faster feedback when making changes.
• Minimize external dependencies and standard library usage.
• Of course -- adding much-needed features.

For more, see the Q&A Wiki

Look

The UI has a simple three-component navigation system :

1. (Left) The slide-out action panel button
2. (Middle) The powerful search bar.
3. (Right) The view change toggle.

All other functions are moved either into the action menu or popup 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 popup menu.

Install and Configuration

See the Configuration Wiki

Command Line Usage

See the CLI Wiki

API Usage

See the API Wiki

Configuration

Configuration is done via the config.yaml, see the Configuration Wiki for available configuration options and other help.

Office File Support

See Office Support Wiki on how to enable office file editing.

Migration from the original filebrowser

See the Migration Wiki

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	31 MB	31 MB	240 MB (main image)	250 MB	❌	> 2 GB
Min. Memory Requirements	128 MB	128 MB	128 MB (main image)	128 MB	❌	4 GB
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	❌	✅	❌	✅	❌	✅
Multiple users	✅	✅	✅	✅	✅	✅
Single sign-on support	❌	❌	❌	✅	✅	✅
LDAP sign-on support	❌	❌	❌	✅	✅	✅
2FA sign-on support	❌	❌	❌	✅	✅	✅
Long-live API key support	✅	❌	✅	✅	✅	✅
API documentation page	✅	❌	✅	✅	❌	✅
Mobile App	❌	❌	❌	❌	✅	❌
open source?	✅	✅	✅	✅	❌	✅
tags support	❌	❌	❌	✅	❌	✅
sharable web links?	✅	✅	✅	✅	✅	✅
Event-based notifications	❌	❌	❌	❌	❌	✅
Metrics	❌	❌	❌	❌	❌	❌
file space quotas	❌	❌	❌	❌	✅	✅
text-based files editor	✅	✅	✅	✅	✅	✅
office file support	✅	❌	✅	✅	✅	✅
Office file previews	❌	❌	❌	✅	✅	✅
Themes	✅	✅	❌	❌	❌	✅
Branding support	✅	✅	❌	❌	❌	✅
activity log	❌	❌	❌	✅	✅	✅
Comments support	❌	❌	❌	✅	✅	✅
trash support	❌	❌	❌	✅	✅	✅
Starred/pinned files	❌	❌	❌	❌	✅	✅
Content preview icons	✅	✅	❌	❌	✅	✅
Chromecast support	❌	❌	✅	❌	❌	❌
Share collections of files	❌	❌	❌	❌	❌	✅
Can archive selected files	❌	❌	❌	❌	❌	✅
Can browse archive files	❌	❌	❌	❌	❌	✅