Samba share for Home Assistant (app)

About

Samba share is an app that exposes Home Assistant folders over SMB/CIFS to other devices on the network. It runs on Home Assistant OS on aarch64 and amd64 hardware, uses the host network directly, and has no sidebar page of its own. Setup is done in the app configuration, where a username, password, workgroup, enabled shares and allowed hosts are set. The username and password are separate from the Home Assistant login. Optional settings hide unwanted files such as macOS and Windows temporary files, enable legacy protocol and NetBIOS support for older clients, and improve interoperability with Apple devices. Network discovery through Web Services Dynamic Discovery lets the host appear in Windows File Explorer, and a server signing option sets the SMB signing requirement.

Automatic summary of the docs and configuration of home-assistant/apps. Something wrong, or are you the maintainer and want your own text here? Get in touch

Supports

Updated with Home Assistant Ships and updates with every Home Assistant release.

Setting it up

Install it under Settings, Apps, then start it.

Permissions

Host networkUses the host's network directly instead of its own.
Supervisor APICan talk to the Supervisor, which manages apps and the system.

Configuration

UsernameThe username you would like to use to authenticate with the Samba server.
PasswordThe password that goes with the username configured for authentication.
WorkgroupChange WORKGROUP to reflect your network needs.
Enabled Shares - allowed values are: local_apps, app_configs, backup, config, media, share, or ssl.List of file shares to make available. Adding a share requires typing its name to add it. The legacy names addons and addon_configs are still accepted and map to local_apps and app_configs for backward compatibility. Only these values are allowed; the configuration cannot be saved if any other value is in the list.
Enable Compatibility ModeEnable this to use old legacy Samba protocols on the Samba app.
Enable Compatibility Settings for Apple DevicesEnable Samba configurations to improve interoperability with Apple devices. May cause issues with file systems that do not support xattr such as exFAT.
Enable NetBIOS over IPEnable NetBIOS over IP for legacy SMB clients (Windows 95/98/ME, Windows NT, Windows 2000, Windows XP and LanManager clients). Disable to improve security and performance if you do not have legacy SMB clients.
Local masterWhen NetBIOS is enabled, try and become a local master browser on a subnet.
Enable network discoveryAdvertise the host with Web Services Dynamic Discovery so it appears automatically under Network in Windows File Explorer. Disable if you connect by hostname or IP address and do not want the host to announce itself on the network. Shares stay reachable either way.
Server signingConfigure SMB server message signing requirements. Refer to the smb.conf man page for more information. Only change this if you know your SMB clients can support it.
Veto FilesList of files that are neither visible nor accessible.
Allowed HostsList of hosts/networks allowed to access the shared folders.