Skip to content

gtsteffaniak/filebrowser

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

Go Report Card Codacy Badge latest version DockerHub Pulls Apache-2.0 License

Donate

FileBrowser Quantum

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

Warning

There is no stable version -- 🚧 planned for 2025. (Read more)

Poll: how much RAM does your install use?

About

FileBrowser Quantum provides an easy way to access and manage your files from the web. It has has a web page interface that allows you to create secure shared links, users with their own specific permissions and settings, and offers a great viewing experience for many file types.

This version is called "Quantum" because it packs tons of advanced features into a tiny 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 Wiki.

How its different

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

  1. βœ… Multiple sources support
  2. βœ… Login support for OIDC, password + 2FA, and proxy.
  3. βœ… Revamped UI
  4. βœ… Simplified configuration via config.yaml config file.
  5. βœ… Ultra-efficient indexing and real-time updates
    • 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
    • More file type previews, such as office and video file previews
    • Instantly switches view modes and sort order without reloading data.
    • Folder sizes are displayed.
    • Navigating remembers the last scroll position.
  7. βœ… 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):

  • 🚧 jobs are not supported yet.
  • 🚧 rules are not supported yet.
  • ❌ shell commands are completely removed and will not be returned.

Warning

Every file and directory in the source gets indexed (by default). This enables powerful features such as instant search, but large source filesystems can increase your system requirements. See indexing wiki for more info.

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.
  3. (Right) The view change toggle.

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.

Install and Configuration

Check out the Getting Started Wiki

For help configuring your filebrowser see Configuration Wiki

Command Line Usage

See the CLI Wiki

API Usage

See the API Wiki

Office File Support

See Office Support Wiki on how to enable office file editing and office-related features.

Migration from the original filebrowser

See the Migration Wiki

Other Questions

For more, see the Q&A 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 200 MB (with ffmpeg) 31 MB 240 MB (main image) 250 MB ❌ > 2 GB
Min. Memory Requirements 256 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 🚧 βœ… ❌ βœ… ❌ βœ…
Multiple users βœ… βœ… βœ… βœ… βœ… βœ…
Single sign-on support βœ… ❌ ❌ βœ… βœ… βœ…
LDAP sign-on support 🚧 ❌ ❌ βœ… ❌ βœ…
Long-live API key support βœ… ❌ βœ… βœ… βœ… βœ…
API documentation page βœ… ❌ βœ… βœ… ❌ βœ…
Mobile App ❌ ❌ ❌ βœ… βœ… ❌
open source? βœ… βœ… βœ… βœ… ❌ ❌
tags support 🚧 ❌ ❌ βœ… ❌ βœ…
shareable 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 ❌ ❌ ❌ ❌ βœ… βœ…
Chromecast support ❌ ❌ βœ… ❌ ❌ ❌
Share collections of files 🚧 ❌ ❌ ❌ ❌ βœ…
Can archive selected files 🚧 ❌ ❌ ❌ ❌ βœ…
Can browse archive files 🚧 ❌ ❌ ❌ ❌ βœ…
Can convert documents 🚧 ❌ ❌ ❌ ❌ βœ…
Can convert videos 🚧 ❌ ❌ ❌ ❌ ❌
Can convert photos 🚧 ❌ ❌ ❌ ❌ ❌

About

πŸ“‚ Web File Browser

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors 11