Home assistant add-on: FileBrowser Quantum
I maintain this and other Home Assistant add-ons in my free time: keeping up with upstream changes, HA changes, and testing on real hardware takes a lot of time (and some money). I use around 5-10 of my >110 addons so regularly I install test machines (and purchase some test services such as vpn) that I don't use myself to troubleshoot and improve the addons
If this add-on saves you time or makes your setup easier, I would be very grateful for your support!
Addon informations
Thanks to everyone having starred my repo! To star it click on the image below, then it will be on top right. Thanks!
About
FileBrowser Quantum is a modern, responsive, multi-source file manager with realtime indexing, advanced sharing, and expanded authentication options (password, proxy, OIDC, or no-auth). It is a major fork of the original Filebrowser project, designed for faster browsing and richer previews.
This addon is based on the docker image from the FileBrowser Quantum project.
Installation
The installation of this add-on is pretty straightforward and not different in comparison to installing any other Home Assistant add-on.
- Add my Home Assistant add-ons repository to your Home Assistant instance.
- Install this add-on.
- Click the
Savebutton to store your configuration. - Start the add-on.
- Check the logs of the add-on to see if everything went well.
- Access the web UI through the sidebar or at
<your-ip>:8071.
Configuration
The web UI can be found at <your-ip>:8071 or through the Home Assistant sidebar when using Ingress.
Default credentials:
- Username:
admin - Password:
admin
Important: Change the default credentials immediately after first login for security.
Options
| Option | Type | Default | Description |
|---|---|---|---|
ssl |
bool | false |
Enable HTTPS for web interface |
certfile |
str | fullchain.pem |
SSL certificate file (in /ssl/) |
keyfile |
str | privkey.pem |
SSL private key file (in /ssl/) |
auth_method |
list | password |
Authentication method (password, noauth, proxy, oidc) |
admin_username |
str | admin |
Admin username for initial setup |
admin_password |
str | admin |
Admin password for initial setup |
token_expiration_hours |
int | 2 |
Auth session token lifetime |
password_min_length |
int | 5 |
Minimum password length for password auth |
password_signup |
bool | false |
Allow signup on login page (password auth) |
password_enforced_otp |
bool | false |
Enforce OTP for password users |
proxy_auth_header |
str | (optional) | Header name for proxy auth |
proxy_auth_create_user |
bool | false |
Auto-create users with proxy auth |
proxy_auth_logout_redirect_url |
str | (optional) | Logout redirect URL for proxy auth |
oidc_client_id |
str | (optional) | OIDC client ID |
oidc_client_secret |
str | (optional) | OIDC client secret |
oidc_issuer_url |
str | (optional) | OIDC issuer URL |
oidc_scopes |
str | (optional) | OIDC scopes (space-separated) |
oidc_user_identifier |
str | (optional) | OIDC user identifier claim |
oidc_admin_group |
str | (optional) | OIDC admin group |
oidc_groups_claim |
str | (optional) | OIDC groups claim |
oidc_logout_redirect_url |
str | (optional) | OIDC logout redirect URL |
oidc_create_user |
bool | false |
Auto-create users with OIDC |
oidc_disable_verify_tls |
bool | false |
Disable TLS verification for OIDC |
base_url |
str | (optional) | Base URL override (defaults to ingress path) |
external_url |
str | (optional) | External URL used for share links |
internal_url |
str | (optional) | Internal URL used for integrations |
disable_update_check |
bool | false |
Disable update checking |
disable_previews |
bool | false |
Disable all previews |
disable_preview_resize |
bool | false |
Disable preview resizing |
disable_type_detection_by_header |
bool | false |
Disable type detection by header |
cache_dir_cleanup |
bool | true |
Automatically clean cache directory |
max_archive_size_gb |
int | 0 |
Max archive size in GB (0 = default) |
log_levels |
str | `info | warning |
sources |
list | (see example) | File sources to expose |
localdisks |
str | (optional) | Local drives to mount (e.g., sda1,sdb1,MYNAS) |
networkdisks |
str | (optional) | SMB shares to mount (e.g., //SERVER/SHARE) |
cifsusername |
str | (optional) | SMB username for network shares |
cifspassword |
str | (optional) | SMB password for network shares |
cifsdomain |
str | (optional) | SMB domain for network shares |
Example Configuration
ssl: true
certfile: "fullchain.pem"
keyfile: "privkey.pem"
auth_method: password
admin_username: "admin"
admin_password: "supersecret"
password_min_length: 8
sources:
- path: "/share"
name: "Share"
default_enabled: true
default_user_scope: "/"
create_user_dir: false
disable_indexing: false
deny_by_default: false
private: false
Setup
- Start the add-on and wait for it to initialize.
- Access the web interface through the Home Assistant sidebar or at
<your-ip>:8071. - Log in using the default credentials:
- Username:
admin - Password:
admin
- Username:
- Important: Immediately change the default password by clicking on "Settings" > "User Management".
- Configure additional sources and authentication settings through the add-on options or the web interface.
Mounting Drives
This addon supports mounting both local drives and remote SMB shares:
- Local drives: See Mounting Local Drives in Addons
- Remote shares: See Mounting Remote Shares in Addons
Custom Scripts and Environment Variables
This addon supports custom scripts and environment variables through the addon_config mapping:
- Custom scripts: See Running Custom Scripts in Addons
- env_vars option: Use the add-on
env_varsoption to pass extra environment variables (uppercase or lowercase names). See https://github.com/alexbelgium/hassio-addons/wiki/Add-Environment-variables-to-your-Addon-2 for details.
Support
Create an issue on GitHub, or ask on the Home Assistant Community thread.