Home Assistant addon : FileBrowser

alexbelgium · February 18, 2021, 3:48pm

Hi, I’ve create an addon for my use and wanted to share it if it can be useful to other people

About

Filebrowser is a web-based file browser developed by the filebrowser team. It provides a file managing interface within a specified directory and it 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 own directory. It can be used as a standalone app or as a middleware.

This addon is based on the docker image from hurlenko.

This addons has several configurable options :

allowing to smb shares from the addon (including smb v1)
optional usage of ssl
optional password protection

Installation

The installation of this add-on is pretty straightforward and not different in comparison to installing any other add-on.

Add my Hass.io add-ons repository to your home assistant instance.
Install this add-on.
Click the Save button to store your configuration.
Set the add-on options to your preferences
Start the add-on.
Check the logs of the add-on to see if everything went well.
Open the webUI and adapt the software options

Configuration

Webui can be found at http://your-ip:8080.
The default username/password : “admin” and password: “admin” (described in the startup log).
Configurations can be done through the app webUI, except for the following options

Network disk is mounted to /share/$ShareName

ssl: true/false
certfile: fullchain.pem #ssl certificate
keyfile: privkey.pem #sslkeyfile
NoAuth: true/false #Remove password. Resets database when changed. 
networkdisks: "//SERVER/SHARE" # optional, list of smbv2/3 servers to mount, separated by commas
cifsusername: "username" # optional, smb username, same for all smb shares
cifspassword: "password" # optional, smb password, same for all smb shares)

Illustration

Syntox · February 18, 2021, 4:19pm

Nice work!
I installed your file browser to be able to access my NAS files from HA. But my NAS uses SMB1 (I know it’s really insecure) and it seems like your addon doesn’t support that. Then I saw your other addons and I guess you have a bit of experience. Would it be possible to write an integration to add a NAS directory to the HA media browser? I think a whole addon with a web interface and so is too much for my use case.

Thanks

alexbelgium · February 18, 2021, 4:36pm

@Syntox Thanks! It should support SMB1, do you have an error message?

Mounting SMB to the HA Media Browser is complicated through an external extension as mounts can’t be propagated from one container to the other (as far as I know). What you can do however is execute a script at boot that mounts the smb share.

For that, you need to create a custom shell command in the configuration.yaml, and a script to call it. The script will call it in the homeassistant container, so files will be available in the HA media browser but not in other extensions (reason why I put a smb mount on each of my addons!). Please find all information here in this thread : Mount remote smb share on hassio

An alternative is to use this addon (that I haven’t used yet) that executes the same command automatically in the homeassistant container : Run On Startup.d - Home Assistant OS - Home Assistant Community (home-assistant.io)

alexbelgium · February 18, 2021, 6:16pm

Hi, I’ve added a switch to allow smbv1. Uninstall the addon, refresh the repositories (button at the same menu where to add custom menus), reinstall it, and you’ll find a checkbox to allow smbv1!

keithcroshaw · February 18, 2021, 6:39pm

I’ve wanted to make HA into an NVR for a while.
One that would just store clips based on events.
This might help with being able to review them.

Thanks for the work.

Syntox · February 18, 2021, 10:48pm

Wow that was fast, instantly worked and it looks awesome! Thanks.

I’ve looked at this:

a few moths ago with the end result of having the NAS mounted but not showing up in the Media Browser. I’ll give your second link a try.

adamoutler · February 19, 2021, 3:09am

I was just trying to play around to see what it did for myself. I started it without error, but the Ingress gave me a server error. I didn’t read and I didn’t configure, and it didn’t work… What do I expect? Dunno. I uninstalled because I don’t need it. Just a random more-stuff fueled install and remove. Just thought I’d share a perspective. Nice collection of Add-ons!

alexbelgium · February 19, 2021, 7:19am

Ahah, Thanks for the feedback! I recognize myself in this behavior also
Normally it should start even without any configuration, but if ssl is enabled there is a 1min delay between start and, webui availability (not sure why). Do you remember the error you got on the WEBUI? BTW, thanks for your own addons, very interesting to configure hassio without need for root console!

adamoutler · February 19, 2021, 12:23pm

I don’t remember the error. I didn’t even give it a minute. But you might try something like this to improve user experience during that first minute, by letting the user know things are happening but the web ui is not yet available.

nc -lk -p 8099 -e  echo -e 'HTTP/1.1 200 OK\r\nServer: FileBrowser\r\nDate:$(date)\r\nContent-Type: text/html; charset=UTF8\r\nCache-Control: no-store, no cache, must-revalidate\r\n\r\n<!DOCTYPE html><html><body><p>Please wait while XXX. It can take 1 minute.</body></html>\r\n\n\n' 3>/dev/null &
serverPID=$!;
#do stuff here.
#bring up server
kill ${serverPID};

pbvdven · February 20, 2021, 11:10am

hi,

nice work but can you please help me get it up and running? i dont know what im doing wrong but the addon wont start

[11:03:52] INFO: PUID GUID set to root
[11:03:52] INFO: Mounting smb share(s)...
rm: can't remove '/mnt/share': No such file or directory
[11:03:53] INFO: ... //192.168.2.16/public/share successfully mounted to /mnt/share
[11:03:53] INFO: Default username/password : admin/admin
[11:03:53] INFO: Please wait 1 or 2 minutes to allow the server to load
/run: line 64: NOAUTH: unbound variable

alexbelgium · February 20, 2021, 11:35am

Sorry I was doing a test with noauth on the addon and you downloaded it while i was testing if you uninstall the addon, go to the place where you added the custom repository, click on Reload, then reinstall once the screen comes back on it will work! I’ve removed the code linked to noauth so I’m sure it’s this cause

I’ll find a way in the future to test without breaking things for people who download

pbvdven · February 20, 2021, 11:44am

thanks for your fast reply. i did uninstall the addon but sill i having the same problem.

pbvdven · February 20, 2021, 11:47am

forgot to reload trying agian.

pbvdven · February 20, 2021, 11:51am

your the BEST thanks a lot

alexbelgium · February 20, 2021, 12:00pm

In case other people had the issue I made a.new version 2.11.0-rev2 so it will be more apparent of reload was successful or not

PrayerfulDrop · February 21, 2021, 11:01pm

Any chance to allow users to specify the mint location? I would like this to mount into the media directory of HA so my music is available through HA media browser. Thoughts?

alexbelgium · February 22, 2021, 10:19am

Hi, it won’t work because the HA media browser is linked to HA container and mounts are not propagated from one container to the other… Please read this post someone had exactly the same question and I added two possible solutions : Home Assistant addon : FileBrowser

Have a nice day

alexbelgium · June 27, 2021, 9:32am

New features :

NoAuth: true/false #Remove password. Resets database when changed.
Optimize smb mount code. New mount point is in /mnt

Taldir · July 3, 2021, 5:04pm

Hi,

I got the following error surfing startup:

nginx: [emerg] invalid port in “172.30.33.7:” of the “listen” directive in /etc/nginx/servers/ingress.conf:2

Could you please help?

Plugin version: 2.15.0-dev2
HASS version: core-2021.6.6

Thanks in advance!

alexbelgium · July 3, 2021, 5:28pm

Thanks for reporting! I started implementing ingress then stopped and that’s a residue.
I’ve pushed a new version (v3) it should work better!