[!WARNING] Starting with v0.2.0, ALL configuration is done via
filebrowser.yaml
Configuration file. Starting with v0.2.4 ALL share links need to be re-created (due to security fix).
FileBrowser Quantum is a fork of the filebrowser opensource project with the following changes:
filebrowser.yml
config file.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 to 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:
One way you can observe the improved user experience is how I changed the UI. The Navbar is simplified to a three-component system :
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.
Using docker:
docker run -it -v /path/to/folder:/srv -p 80:80 gtstef/filebrowser
docker compose:
version: '3.7'
services:
filebrowser:
volumes:
- '/path/to/folder:/srv' # required (for now not configurable)
- './database:/database' # optional if you want db to persist - configure a path under "database" dir in config file.
- './filebrowser.yaml:/filebrowser.yaml' # required
ports:
- '80:80'
image: gtstef/filebrowser
restart: always
version: '3.7'
services:
filebrowser:
volumes:
- 'storage:/srv' # required (for now not configurable)
- './database:/database' # optional if you want db to persist - configure a path under "database" dir in config file.
- './filebrowser.yaml:/filebrowser.yaml' # required
ports:
- '80:80'
image: gtstef/filebrowser
restart: always
volumes:
storage:
driver_opts:
type: cifs
o: "username=admin,password=password,rw" # enter valid info here
device: "//192.168.1.100/share/" # enter valid hinfo here
Not using docker (not recommended), download your binary from releases and run with your custom config file:
./filebrowser -c <filebrowser.yml or other /path/to/config.yaml>
All configuration is now done via a single configuration file:
filebrowser.yaml
, here is an example of minimal configuration
file.
View the Configuration Help Page for available configuration options and other help.
If you currently use the original opensource filebrowser but want to try using this. I recommend you start fresh without reusing the database, but there are a few things you'll need to do if you must migrate:
The filebrowser Quantum application should run with the same user and rules that you have from the original. But keep in mind the differences that are mentioned at the top of this readme.
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 | 22 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 | β | β | β | β | β | β |
Mobile App | β | β | β | β | β | β |
open source? | β | β | β | β | β | β |
tags support | β | β | β | β | β | β |
sharable web links? | β | β | β | β | β | β |
Event-based notifications | β | β | β | β | β | β |
Metrics | β | β | β | β | β | β |
file space quotas | β | β | β | β | β | β |
text-based files editor | β | β | β | β | β | β |
office file support | β | β | β | β | β | β |
Themes | β | β | β | β | β | β |
Branding support | β | β | β | β | β | β |
activity log | β | β | β | β | β | β |
Comments support | β | β | β | β | β | β |
collaboration on same file | β | β | β | β | β | β |
trash support | β | β | β | β | β | β |
Starred/pinned files | β | β | β | β | β | β |
Content preview icons | β | β | β | β | β | β |
Plugins support | β | β | β | β | β | β |
Chromecast support | β | β | β | β | β | β |
see Roadmap Page